com.smartgwt.client.widgets.form.fields
Class ButtonItem

java.lang.Object
  extended by com.smartgwt.client.core.JsObject
      extended by com.smartgwt.client.core.DataClass
          extended by com.smartgwt.client.core.RefDataClass
              extended by com.smartgwt.client.widgets.form.fields.FormItem
                  extended by com.smartgwt.client.widgets.form.fields.CanvasItem
                      extended by com.smartgwt.client.widgets.form.fields.ButtonItem
All Implemented Interfaces:
HasHandlers, HasBlurHandlers, HasChangedHandlers, HasChangeHandlers, HasClickHandlers, HasDoubleClickHandlers, HasFocusHandlers, HasIconClickHandlers, HasIconKeyPressHandlers, HasItemHoverHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasKeyUpHandlers, HasTitleHoverHandlers
Direct Known Subclasses:
ResetItem, SubmitItem

public class ButtonItem
extends CanvasItem
implements HasClickHandlers

FormItem for adding a Button to a form.


Field Summary
 
Fields inherited from class com.smartgwt.client.core.JsObject
jsObj
 
Constructor Summary
ButtonItem()
           
ButtonItem(com.google.gwt.core.client.JavaScriptObject jsObj)
           
ButtonItem(java.lang.String name)
           
ButtonItem(java.lang.String name, java.lang.String title)
           
 
Method Summary
 HandlerRegistration addClickHandler(ClickHandler handler)
          Add a click handler.
 java.lang.Boolean getAutoFit()
          Should the button auto fit to its title.
 java.lang.String getBaseStyle()
          Optional baseStyle will be applied to the button.
 Canvas getCanvas()
          The canvas that will be displayed inside this item.
 java.lang.Boolean getEndRow()
          These items are in a row by themselves by default
 java.lang.String getIcon()
          Return the icon.
static ButtonItem getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
           
 java.lang.Boolean getShowTitle()
          Buttons do not show a title by default.
 java.lang.Boolean getStartRow()
          These items are in a row by themselves by default
 void setAutoFit(java.lang.Boolean autoFit)
          Should the button auto fit to its title.
 void setBaseStyle(java.lang.String baseStyle)
          Optional baseStyle will be applied to the button.
 void setEndRow(java.lang.Boolean endRow)
          These items are in a row by themselves by default
 void setIcon(java.lang.String icon)
          Set the icon.
 void setShowTitle(java.lang.Boolean showTitle)
          Buttons do not show a title by default.
 void setStartRow(java.lang.Boolean startRow)
          These items are in a row by themselves by default
 
Methods inherited from class com.smartgwt.client.widgets.form.fields.CanvasItem
setCanvas
 
Methods inherited from class com.smartgwt.client.widgets.form.fields.FormItem
addBlurHandler, addChangedHandler, addChangeHandler, addDoubleClickHandler, addFocusHandler, addIconClickHandler, addIconKeyPressHandler, addItemHoverHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addTitleHoverHandler, blurItem, disable, enable, focusInItem, getAccessKey, getAlign, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsString, getCellStyle, getConfig, getCriteriaField, getCriterion, getDateFormatter, getDefaultIconSrc, getDisabled, getDisplayField, getDisplayFieldName, getDisplayValue, getDisplayValue, getEmptyDisplayValue, getEmptyValueIcon, getErrorIconHeight, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getFetchMissingValues, getFieldName, getFilterLocally, getGlobalTabIndex, getHeight, getHint, getHintStyle, getHoverAlign, getHoverDelay, getHoverHeight, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getIconHeight, getIconPageRect, getIconPrompt, getIconRect, getIconVAlign, getIconWidth, getImageURLPrefix, getImageURLSuffix, getLeft, getName, getOperator, getPickerIconHeight, getPickerIconSrc, getPickerIconWidth, getPrompt, getRejectInvalidValueOnChange, getRequired, getRowSpan, getSelectOnFocus, getShouldSaveValue, getShowDisabled, getShowErrorIcon, getShowErrorStyle, getShowErrorText, getShowFocused, getShowFocusedIcons, getShowFocusedPickerIcon, getShowHint, getShowIcons, getShowOverIcons, getShowPickerIcon, getShowValueIconOnly, getSuppressValueIcon, getTabIndex, getTextAlign, getTextBoxStyle, getTimeFormatter, getTitle, getTitleAlign, getTitleOrientation, getTitleStyle, getTooltip, getTop, getType, getValidateOnChange, getValue, getValueField, getValueFieldName, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getVisible, getWidth, getWrapTitle, hide, isCreated, isDisabled, isDrawn, redraw, setAccessKey, setAlign, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setCellStyle, setColSpan, setColSpan, setCriteriaField, setDateFormatter, setDefaultIconSrc, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDisabled, setDisplayField, setEditorType, setEmptyDisplayValue, setEmptyValueIcon, setErrorFormatter, setErrorIconHeight, setErrorIconSrc, setErrorIconWidth, setErrorMessageWidth, setErrorOrientation, setFetchMissingValues, setFilterLocally, setGlobalTabIndex, setHeight, setHeight, setHint, setHintStyle, setHoverAlign, setHoverDelay, setHoverHeight, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setIconHeight, setIconPrompt, setIcons, setIconVAlign, setIconWidth, setImageURLPrefix, setImageURLSuffix, setInputTransformer, setItemHoverFormatter, setItemTitleHoverFormatter, setLeft, setName, setOperator, setOptionDataSource, setPickerIconHeight, setPickerIconSrc, setPickerIconWidth, setPrompt, setProperty, setProperty, setProperty, setProperty, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRowSpan, setSelectOnFocus, setShouldSaveValue, setShowDisabled, setShowErrorIcon, setShowErrorStyle, setShowErrorText, setShowFocused, setShowFocusedIcons, setShowFocusedPickerIcon, setShowHint, setShowIcons, setShowIfCondition, setShowOverIcons, setShowPickerIcon, setShowValueIconOnly, setSuppressValueIcon, setTabIndex, setTextAlign, setTextBoxStyle, setTimeFormatter, setTitle, setTitleAlign, setTitleOrientation, setTitleStyle, setTooltip, setTop, setType, setValidateOnChange, setValidators, setValue, setValue, setValue, setValue, setValue, setValue, setValueField, setValueIconHeight, setValueIconLeftPadding, setValueIconRightPadding, setValueIcons, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setVisible, setWidth, setWidth, setWrapTitle, show, stopHover, updateState
 
Methods inherited from class com.smartgwt.client.core.RefDataClass
getRef, getRef
 
Methods inherited from class com.smartgwt.client.core.DataClass
doAddHandler, fireEvent, getAttributeAsIntArray, getAttributeAsMap, getAttributeAsObject, getAttributeAsStringArray, getAttributes, getHandlerCount, getJsObj, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute
 
Methods inherited from class com.smartgwt.client.core.JsObject
setJsObj
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 

Constructor Detail

ButtonItem

public ButtonItem()

ButtonItem

public ButtonItem(com.google.gwt.core.client.JavaScriptObject jsObj)

ButtonItem

public ButtonItem(java.lang.String name)

ButtonItem

public ButtonItem(java.lang.String name,
                  java.lang.String title)
Method Detail

getOrCreateRef

public static ButtonItem getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)

setBaseStyle

public void setBaseStyle(java.lang.String baseStyle)
Optional baseStyle will be applied to the button.

Parameters:
baseStyle - baseStyle Default value is null

getBaseStyle

public java.lang.String getBaseStyle()
Optional baseStyle will be applied to the button.

Returns:
String

setShowTitle

public void setShowTitle(java.lang.Boolean showTitle)
Buttons do not show a title by default.

Overrides:
setShowTitle in class FormItem
Parameters:
showTitle - showTitle Default value is false

getShowTitle

public java.lang.Boolean getShowTitle()
Buttons do not show a title by default.

Overrides:
getShowTitle in class FormItem
Returns:
Boolean

setStartRow

public void setStartRow(java.lang.Boolean startRow)
These items are in a row by themselves by default

Overrides:
setStartRow in class FormItem
Parameters:
startRow - startRow Default value is true

getStartRow

public java.lang.Boolean getStartRow()
These items are in a row by themselves by default

Overrides:
getStartRow in class FormItem
Returns:
Boolean

setEndRow

public void setEndRow(java.lang.Boolean endRow)
These items are in a row by themselves by default

Overrides:
setEndRow in class FormItem
Parameters:
endRow - endRow Default value is true

getEndRow

public java.lang.Boolean getEndRow()
These items are in a row by themselves by default

Overrides:
getEndRow in class FormItem
Returns:
Boolean

setAutoFit

public void setAutoFit(java.lang.Boolean autoFit)
Should the button auto fit to its title. Maps to autoFit attribute. Note that if an explicit width or height is specified for this item, it will be respected, disabling autoFit behavior

Parameters:
autoFit - autoFit Default value is true

getAutoFit

public java.lang.Boolean getAutoFit()
Should the button auto fit to its title. Maps to autoFit attribute. Note that if an explicit width or height is specified for this item, it will be respected, disabling autoFit behavior

Returns:
Boolean

addClickHandler

public HandlerRegistration addClickHandler(ClickHandler handler)
Add a click handler.

Called when a ButtonItem is clicked on.

Specified by:
addClickHandler in interface HasClickHandlers
Overrides:
addClickHandler in class FormItem
Parameters:
handler - the click handler
Returns:
HandlerRegistration used to remove this handler

setIcon

public void setIcon(java.lang.String icon)
Set the icon.

Parameters:
icon - the icon

getIcon

public java.lang.String getIcon()
Return the icon.

Returns:
the icon

getCanvas

public Canvas getCanvas()
Description copied from class: CanvasItem
The canvas that will be displayed inside this item. You can pass an instance you've already created, or its global ID as a String. If none is passed, one will be auto-created using the overrideable defaults: canvasProperties and canvasConstructor

Overrides:
getCanvas in class CanvasItem
Returns:
Canvas