public class ButtonItem extends CanvasItem implements HasClickHandlers
FormItem.CustomStateGetter, FormItem.StateCustomizerscClassName, warnOnEditorTypeConversion, warnOnEditorTypeConversionDefaultidfactoryCreated, factoryProperties, readOnly| Constructor and Description |
|---|
ButtonItem() |
ButtonItem(com.google.gwt.core.client.JavaScriptObject jsObj) |
ButtonItem(java.lang.String name) |
ButtonItem(java.lang.String name,
java.lang.String title) |
| Modifier and Type | Method and Description |
|---|---|
com.google.gwt.event.shared.HandlerRegistration |
addClickHandler(ClickHandler handler)
Add a click handler.
|
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
Changes the defaults for Canvas AutoChildren named
autoChildName. |
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
DrawItem defaults)
Changes the defaults for DrawItem AutoChildren named
autoChildName. |
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
Changes the defaults for FormItem AutoChildren named
autoChildName. |
static void |
changePickerIconDefaults(FormItemIcon defaults) |
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 |
getButton()
|
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()
Optional icon image to display on the button for this item.
|
static ButtonItem |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
ReadOnlyDisplayAppearance |
getReadOnlyDisplay()
If this item is
read-only, how should this item be
displayed to the user? If set, overrides the form-level DynamicForm.readOnlyDisplay default. |
java.lang.Boolean |
getShowFocusedAsOver()
This property governs whether
showFocusedAsOver
is true on the automatically created Button for this item. |
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 |
setButtonProperties(Button buttonProperties)
Custom Properties to apply to the button item.
|
static void |
setDefaultProperties(ButtonItem buttonItemProperties)
Class level method to set the default properties of this class.
|
void |
setEndRow(java.lang.Boolean endRow)
These items are in a row by themselves by default
|
void |
setIcon(java.lang.String icon)
Optional icon image to display on the button for this item.
|
void |
setReadOnlyDisplay(ReadOnlyDisplayAppearance readOnlyDisplay)
If this item is
read-only, how should this item be
displayed to the user? If set, overrides the form-level DynamicForm.readOnlyDisplay default. |
void |
setShowFocusedAsOver(java.lang.Boolean showFocusedAsOver)
This property governs whether
showFocusedAsOver
is true on the automatically created Button for this item. |
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
|
addCanEditChangedHandler, addReadOnlyDisplayChangedHandler, addShowValueHandler, createCanvas, getApplyPromptToCanvas, getAutoDestroy, getEditCriteriaInInnerForm, getHeight, getHeightAsString, getMultiple, getOverflow, getPrompt, getShouldSaveValue, hasAdvancedCriteria, isFocused, setApplyPromptToCanvas, setAutoDestroy, setCanEditCriterionPredicate, setCanvas, setCriterionGetter, setCriterionSetter, setDefaultProperties, setEditCriteriaInInnerForm, setHeight, setHeight, setMultiple, setOverflow, setPrompt, setShouldDisableCanvasCustomizer, setShouldSaveValue, setupCanvasConstructor, storeValue, storeValue, storeValue_getValue, addBlurHandler, addChangedHandler, addChangeHandler, addDoubleClickHandler, addEditorEnterHandler, addEditorExitHandler, addFocusHandler, addIconClickHandler, addIconKeyPressHandler, addItemHoverHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addPendingStatusChangedHandler, addPickerIconClickHandler, addTitleClickHandler, addTitleDoubleClickHandler, addTitleHoverHandler, addValueHoverHandler, addValueIconClickHandler, asSGWTComponent, blurItem, canEditCriterion, clearErrors, clearValue, disable, disableIcon, enable, enableIcon, error, error, errorIfNotCreated, focusInItem, getAccessKey, getAlign, getAllowExpressions, getAlwaysFetchMissingValues, getApplyAlignToText, getApplyHeightToTextBox, getAriaRole, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsObject, getAttributeAsString, getAutoComplete, getBrowserInputType, getBrowserSpellCheck, getCanEdit, getCanEditOpaqueValues, getCanFocus, getCanSelectText, getCanvasAutoChild, getCellHeight, getCellStyle, getChangeOnKeypress, getClassName, getClipStaticValue, getClipTitle, getConfig, getContainerWidget, getControlStyle, getCriteriaField, getCriterion, getCriterion, getCursorPosition, getCustomState, getDataPath, getDateFormatter, getDecimalPad, getDecimalPrecision, getDefaultIconSrc, getDisabled, getDisableIconsOnReadOnly, getDisplayField, getDisplayFieldName, getDisplayValue, getDisplayValue, getEditorTypeConfig, getEditPendingCSSText, getEditProxyConstructor, getEmptyDisplayValue, getEmptyValueIcon, getErrorIconHeight, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getErrors, getExportFormat, getFetchMissingValues, getFieldName, getFilterLocally, getForeignDisplayField, getForm, getFormat, getFormItemAutoChild, getFullDataPath, getGlobalTabIndex, getGridColNum, getGridRowNum, getHidden, getHint, getHintStyle, getHoverAlign, getHoverDelay, getHoverHeight, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getIcon, getIconHeight, getIconHSpace, getIconPageRect, getIconPrompt, getIconRect, getIconVAlign, getIconWidth, getImageURLPrefix, getImageURLSuffix, getImplicitSave, getImplicitSaveOnBlur, getInputFormat, getLeft, getLoadingDisplayValue, getLocateItemBy, getMultipleValueSeparator, getName, getOperator, getOptionCriteria, getOptionFilterContext, getOptionOperationId, getOriginalValueMessage, getPageLeft, getPageRect, getPageTop, getPicker, getPickerIconHeight, getPickerIconName, getPickerIconPrompt, getPickerIconProperties, getPickerIconSrc, getPickerIconStyle, getPickerIconWidth, getPixelHeight, getPixelWidth, getPrintTextBoxStyle, getPrintTitleStyle, getReadOnlyHover, getReadOnlyTextBoxStyle, getRect, getRedrawOnChange, getRejectInvalidValueOnChange, getRequired, getRequiredMessage, getRowSpan, getSaveOnEnter, getScClassName, getSelectedRecord, getSelectOnClick, getSelectOnFocus, getShowClippedTitleOnHover, getShowClippedValueOnHover, getShowDeletions, getShowDisabled, getShowErrorIcon, getShowErrorStyle, getShowErrorText, getShowFocused, getShowFocusedErrorState, getShowFocusedIcons, getShowFocusedPickerIcon, getShowHint, getShowIcons, getShowOldValueInHover, getShowOverIcons, getShowPending, getShowPickerIcon, getShowRTL, getShowValueIconOnly, getStaticHeight, getStopOnError, getSupportsCutPasteEvents, getSuppressValueIcon, getSynchronousValidation, getTabIndex, getTextAlign, getTextBoxStyle, getTimeFormatter, getTitle, getTitleAlign, getTitleColSpan, getTitleOrientation, getTitleStyle, getTitleVAlign, getTooltip, getTop, getType, getUseDisabledHintStyleForReadOnly, getValidateOnChange, getValidateOnExit, getValidOperators, getVAlign, getValue, getValueAsRecordList, getValueDeselectedCSSText, getValueField, getValueFieldName, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getVisible, getVisibleHeight, getVisibleTitleWidth, getVisibleWidth, getWarnOnEditorTypeConversion, getWarnOnEditorTypeConversionDefault, getWidth, getWidthAsString, getWrapTitle, handleWarnOnEditorTypeConversion, hasErrors, hide, hideIcon, invalidateDisplayValueCache, isCreated, isCutEvent, isDisabled, isDrawn, isInGrid, isPasteEvent, isVisible, linkToInstanceUponCreate, mapDisplayToValue, mapValueToDisplay, mapValueToDisplay, mapValueToDisplay, redraw, redraw, setAccessKey, setAlign, setAllowExpressions, setAlwaysFetchMissingValues, setApplyAlignToText, setApplyHeightToTextBox, setAriaRole, setAriaState, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoComplete, setBrowserInputType, setBrowserSpellCheck, setCanEdit, setCanEditOpaqueValues, setCanFocus, setCanSelectText, setCellHeight, setCellStyle, setChangeOnKeypress, setClipStaticValue, setClipTitle, setColSpan, setColSpan, setControlStyle, setCriteriaField, setCriterion, setCustomStateGetter, setDataPath, setDateFormatter, setDecimalPad, setDecimalPrecision, setDefaultIconSrc, setDefaultProperties, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDisabled, setDisableIconsOnReadOnly, setDisplayField, setDisplayFormat, setDisplayFormat, setEditorProperties, setEditorType, setEditorType, setEditorType, setEditorValueFormatter, setEditorValueParser, setEditPendingCSSText, setEditProxyConstructor, setEmptyDisplayValue, setEmptyValueIcon, setErrorFormatter, setErrorIconHeight, setErrorIconSrc, setErrorIconWidth, setErrorMessageWidth, setErrorOrientation, setErrors, setErrors, setExportFormat, setFetchMissingValues, setFilterLocally, setForeignDisplayField, setFormat, setGlobalTabIndex, setHidden, setHint, setHintStyle, setHoverAlign, setHoverDelay, setHoverHeight, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setIconDisabled, setIconHeight, setIconHSpace, setIconPrompt, setIcons, setIconVAlign, setIconWidth, setImageURLPrefix, setImageURLSuffix, setImplicitSave, setImplicitSaveOnBlur, setInitHandler, setInputFormat, setInputTransformer, setItemHoverFormatter, setItemTitleHoverFormatter, setItemValueHoverFormatter, setJavaScriptObject, setLeft, setLoadingDisplayValue, setLocateItemBy, setMultipleValueSeparator, setName, setNullProperty, setOperator, setOptionCriteria, setOptionDataSource, setOptionFilterContext, setOptionOperationId, setOriginalValueMessage, setPickerIconHeight, setPickerIconName, setPickerIconPrompt, setPickerIconProperties, setPickerIconSrc, setPickerIconStyle, setPickerIconWidth, setPrintTextBoxStyle, setPrintTitleStyle, setProperty, setProperty, setProperty, setProperty, setProperty, setReadOnlyHover, setReadOnlyTextBoxStyle, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRequiredMessage, setRowSpan, setSaveOnEnter, setScClassName, setSelectOnClick, setSelectOnFocus, setShowClippedTitleOnHover, setShowClippedValueOnHover, setShowDeletions, setShowDisabled, setShowErrorIcon, setShowErrorStyle, setShowErrorText, setShowFocused, setShowFocusedErrorState, setShowFocusedIcons, setShowFocusedPickerIcon, setShowHint, setShowIcons, setShowIfCondition, setShowOldValueInHover, setShowOverIcons, setShowPending, setShowPickerIcon, setShowRTL, setShowValueIconOnly, setStateCustomizer, setStaticHeight, setStopOnError, setSupportsCutPasteEvents, setSuppressValueIcon, setSynchronousValidation, setTabIndex, setTextAlign, setTextBoxStyle, setTimeFormatter, setTitle, setTitleAlign, setTitleColSpan, setTitleHoverFormatter, setTitleOrientation, setTitleStyle, setTitleVAlign, setTooltip, setTop, setType, setUseDisabledHintStyleForReadOnly, setValidateOnChange, setValidateOnExit, setValidators, setValidOperators, setVAlign, setValue, setValue, setValue, setValue, setValue, setValue, setValueDeselectedCSSText, setValueField, setValueFormatter, setValueHoverFormatter, setValueIconHeight, setValueIconLeftPadding, setValueIconMapper, setValueIconRightPadding, setValueIcons, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setVisible, setWarnOnEditorTypeConversion, setWarnOnEditorTypeConversionDefault, setWidth, setWidth, setWrapTitle, shouldApplyHeightToTextBox, shouldFetchMissingValue, shouldSaveOnEnter, shouldStopKeyPressBubbling, show, showIcon, showPicker, stopHover, storeValue, updateState, validate, valueClippedgetRef, getRef, internalSetIDapplyFactoryProperties, doAddHandler, fireEvent, getAttributeAsDoubleArray, getAttributeAsIntArray, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsStringArray, getAttributes, getHandlerCount, getReadOnly, isFactoryCreated, logConfiguration, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreated, setReadOnlypublic ButtonItem()
public ButtonItem(com.google.gwt.core.client.JavaScriptObject jsObj)
public ButtonItem(java.lang.String name)
public ButtonItem(java.lang.String name,
java.lang.String title)
public static ButtonItem getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public static void changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
autoChildName.autoChildName - name of an AutoChild to customize the defaults for.defaults - Canvas defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties. For usage tips on this
param, see SGWTProperties.AutoChildUsagepublic static void changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
autoChildName.autoChildName - name of an AutoChild to customize the defaults for.defaults - FormItem defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties. For usage tips on this
param, see SGWTProperties.AutoChildUsagepublic static void changeAutoChildDefaults(java.lang.String autoChildName,
DrawItem defaults)
autoChildName.autoChildName - name of an AutoChild to customize the defaults for.defaults - DrawItem defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties. For usage tips on this
param, see SGWTProperties.AutoChildUsagepublic static void changePickerIconDefaults(FormItemIcon defaults)
public void setAutoFit(java.lang.Boolean autoFit)
Button.autoFit
attribute. Note that if an explicit width or height is specified for this item, it will be respected, disabling autoFit
behaviorautoFit - Default value is truepublic java.lang.Boolean getAutoFit()
Button.autoFit
attribute. Note that if an explicit width or height is specified for this item, it will be respected, disabling autoFit
behaviorpublic void setBaseStyle(java.lang.String baseStyle)
baseStyle will be applied to the button.baseStyle - See CSSStyleName . Default value is nullAppearance overview and related methodspublic java.lang.String getBaseStyle()
baseStyle will be applied to the button.CSSStyleNameAppearance overview and related methodspublic Canvas getButton()
Canvas displayed by the ButtonItem and is an
instance of Button by defaut, cuztomizeable via the buttonConstructor attribute.
For an overview of how to use and configure AutoChildren, see Using AutoChildren.
public void setEndRow(java.lang.Boolean endRow)
setEndRow in class FormItemendRow - Default value is trueFormLayout overview and related methodspublic java.lang.Boolean getEndRow()
getEndRow in class FormItemFormLayout overview and related methodspublic void setIcon(java.lang.String icon)
Button.icon.icon - See SCImgURL . Default value is nullAppearance overview and related methodspublic java.lang.String getIcon()
Button.icon.SCImgURLAppearance overview and related methodspublic void setReadOnlyDisplay(ReadOnlyDisplayAppearance readOnlyDisplay)
read-only, how should this item be
displayed to the user? If set, overrides the form-level DynamicForm.readOnlyDisplay default.setReadOnlyDisplay in class FormItemreadOnlyDisplay - Default value is "disabled"DynamicForm.setReadOnlyDisplay(com.smartgwt.client.types.ReadOnlyDisplayAppearance)public ReadOnlyDisplayAppearance getReadOnlyDisplay()
read-only, how should this item be
displayed to the user? If set, overrides the form-level DynamicForm.readOnlyDisplay default.getReadOnlyDisplay in class FormItemDynamicForm.getReadOnlyDisplay()public void setShowFocusedAsOver(java.lang.Boolean showFocusedAsOver)
showFocusedAsOver
is true on the automatically created Button for this item.
showFocusedAsOver - Default value is nullpublic java.lang.Boolean getShowFocusedAsOver()
showFocusedAsOver
is true on the automatically created Button for this item.public void setShowTitle(java.lang.Boolean showTitle)
setShowTitle in class FormItemshowTitle - Default value is falseAppearance overview and related methodspublic java.lang.Boolean getShowTitle()
getShowTitle in class FormItemAppearance overview and related methodspublic void setStartRow(java.lang.Boolean startRow)
setStartRow in class FormItemstartRow - Default value is trueFormLayout overview and related methodspublic java.lang.Boolean getStartRow()
getStartRow in class FormItemFormLayout overview and related methodspublic com.google.gwt.event.shared.HandlerRegistration addClickHandler(ClickHandler handler)
Called when a ButtonItem is clicked on.
addClickHandler in interface HasClickHandlersaddClickHandler in class FormItemhandler - the click handlerHandlerRegistration used to remove this handlerpublic static void setDefaultProperties(ButtonItem buttonItemProperties)
Note: This method is intended for setting default attributes only and will affect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.
buttonItemProperties - properties that should be used as new defaults when instances of this class are createdSGWTPropertiespublic Canvas getCanvas()
CanvasItem If a canvas hasn't been specified via setCanvas(), the canvas for this item will be auto-created
as configured by the methods setAutoChildProperties() and setAutoChildConstructor().
Note that subclasses of CanvasItem may use a different AutoChild name than
just "canvas". For example, SliderItem uses "slider", and in that case,
you need to use the specific APIs provided by the subclass.
Note that Canvas.canvasItem will be set on the canvas to point back to this
item.
For an overview of how to use and configure AutoChildren, see Using AutoChildren.
getCanvas in class CanvasItempublic void setButtonProperties(Button buttonProperties)
buttonProperties - properties to apply to the button item.