com.smartgwt.client.widgets.form.fields

Class ToolbarItem

java.lang.Object

com.smartgwt.client.core.JsObject

com.smartgwt.client.core.DataClass

com.smartgwt.client.core.RefDataClass

com.smartgwt.client.data.Field

com.smartgwt.client.widgets.form.fields.FormItem

com.smartgwt.client.widgets.form.fields.CanvasItem

com.smartgwt.client.widgets.form.fields.ToolbarItem

All Implemented Interfaces:

com.google.gwt.event.shared.HasHandlers, HasBlurHandlers, HasCanEditChangedHandlers, HasChangedHandlers, HasChangeHandlers, HasClickHandlers, HasDoubleClickHandlers, HasEditorEnterHandlers, HasEditorExitHandlers, HasFocusHandlers, HasIconClickHandlers, HasIconKeyPressHandlers, HasItemHoverHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasKeyUpHandlers, HasPendingStatusChangedHandlers, HasPickerIconClickHandlers, HasReadOnlyDisplayChangedHandlers, HasShowContextMenuHandlers, HasShowValueHandlers, HasTitleClickHandlers, HasTitleDoubleClickHandlers, HasTitleHoverHandlers, HasValueHoverHandlers, HasValueIconClickHandlers

public class ToolbarItem
extends CanvasItem

Set of horizontally arranged buttons.

Nested Class Summary

Nested classes/interfaces inherited from class com.smartgwt.client.widgets.form.fields.FormItem

FormItem.CustomStateGetter, FormItem.StateCustomizer

Field Summary

Fields inherited from class com.smartgwt.client.widgets.form.fields.FormItem

configOnly, scClassName, warnOnEditorTypeConversion, warnOnEditorTypeConversionDefault

Fields inherited from class com.smartgwt.client.core.RefDataClass

id

Fields inherited from class com.smartgwt.client.core.DataClass

factoryCreated, factoryProperties

Fields inherited from class com.smartgwt.client.core.JsObject

jsObj

Constructor Summary

Constructors

Constructor and Description
ToolbarItem()
ToolbarItem(com.google.gwt.core.client.JavaScriptObject jsObj)
ToolbarItem(java.lang.String name)
ToolbarItem(java.lang.String name, java.lang.String title)

Method Summary

Modifier and Type	Method and Description
static void	changeAutoChildDefaults(java.lang.String autoChildName, Canvas defaults) Changes the defaults for Canvas 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	getButtonAutoFit() Default Button.autoFit for buttons - true by default.
java.lang.String	getButtonBaseStyle() If specified this baseStyle will be applied to the buttons in this toolbar.
int	getButtonSpace() Space between the buttons of this toolbar.
Canvas	getCanvas() This item is an autoChild generated Canvas displayed by the ToolbarItem and is an instance of Toolbar by default.
java.lang.String	getCanvasConstructor() Constructor class for this toolbarItem's canvas.
java.lang.Boolean	getCreateButtonsOnInit() If set to true, causes the toolbar created by this item to create its child buttons during initialization, instead of waiting until draw().
java.lang.String	getEditProxyConstructor() Default class used to construct the EditProxy for this component when the component is first placed into edit mode.
java.lang.Boolean	getEndRow() these items are in a row by themselves by default
static ToolbarItem	getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
java.lang.Boolean	getShowTitle() Don't show a title for toolbars
java.lang.Boolean	getStartRow() these items are in a row by themselves by default
java.lang.Boolean	getVertical() Should the toolbar stack its buttons vertically or horizontally?
ToolbarItem	setButtonAutoFit(java.lang.Boolean buttonAutoFit) Default Button.autoFit for buttons - true by default.
ToolbarItem	setButtonBaseStyle(java.lang.String buttonBaseStyle) If specified this baseStyle will be applied to the buttons in this toolbar.
ToolbarItem	setButtons(StatefulCanvas... buttons) List of buttons for the toolbar.
ToolbarItem	setButtonSpace(int buttonSpace) Space between the buttons of this toolbar.
ToolbarItem	setCanvasConstructor(java.lang.String canvasConstructor) Constructor class for this toolbarItem's canvas.
ToolbarItem	setCreateButtonsOnInit(java.lang.Boolean createButtonsOnInit) If set to true, causes the toolbar created by this item to create its child buttons during initialization, instead of waiting until draw().
static void	setDefaultProperties(ToolbarItem toolbarItemProperties) Class level method to set the default properties of this class.
ToolbarItem	setEditProxyConstructor(java.lang.String editProxyConstructor) Default class used to construct the EditProxy for this component when the component is first placed into edit mode.
ToolbarItem	setEndRow(java.lang.Boolean endRow) these items are in a row by themselves by default
ToolbarItem	setShowTitle(java.lang.Boolean showTitle) Don't show a title for toolbars
ToolbarItem	setStartRow(java.lang.Boolean startRow) these items are in a row by themselves by default
ToolbarItem	setVertical(java.lang.Boolean vertical) Should the toolbar stack its buttons vertically or horizontally?

Methods inherited from class com.smartgwt.client.widgets.form.fields.CanvasItem

addCanEditChangedHandler, addReadOnlyDisplayChangedHandler, addShowValueHandler, createCanvas, getApplyPromptToCanvas, getAutoDestroy, getEditCriteriaInInnerForm, getHeight, getHeightAsString, getMaxHeight, getMinHeight, getMultiple, getOverflow, getPrompt, getShouldSaveValue, hasAdvancedCriteria, isFocused, setApplyPromptToCanvas, setAutoDestroy, setCanEditCriterionPredicate, setCanvas, setCriterionGetter, setCriterionSetter, setDefaultProperties, setEditCriteriaInInnerForm, setHeight, setHeight, setMaxHeight, setMinHeight, setMultiple, setOverflow, setPrompt, setShouldDisableCanvasCustomizer, setShouldSaveValue, setupCanvasConstructor, storeValue, storeValue, storeValue, updateCanvasTabPosition

Methods inherited from class com.smartgwt.client.widgets.form.fields.FormItem

_getValue, addBlurHandler, addChangedHandler, addChangeHandler, addClickHandler, addDoubleClickHandler, addEditorEnterHandler, addEditorExitHandler, addFocusHandler, addIcon, addIcon, addIconClickHandler, addIconKeyPressHandler, addItemHoverHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addPendingStatusChangedHandler, addPickerIconClickHandler, addShowContextMenuHandler, addTitleClickHandler, addTitleDoubleClickHandler, addTitleHoverHandler, addValueHoverHandler, addValueIconClickHandler, applyFormula, asSGWTComponent, blurItem, canEditCriterion, checkFormItemType, clearErrors, clearValue, disable, disableIcon, enable, enableIcon, error, error, errorIfNotCreated, focusAfterItem, focusInItem, getAccessKey, getAlign, getAllowExpressions, getAlwaysFetchMissingValues, getAlwaysShowControlBox, getApplyAlignToText, getApplyHeightToTextBox, getAriaRole, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsObject, getAttributeAsString, getAutoComplete, getAutoCompleteKeywords, getBrowserInputType, getBrowserSpellCheck, getCanEdit, getCanEditOpaqueValues, getCanFocus, getCanHover, getCanSelectText, getCanTabToIcons, getCanvasAutoChild, getCellHeight, getCellStyle, getChangeOnKeypress, getClassName, getClipStaticValue, getClipTitle, getConfig, getContainerWidget, getControlStyle, getCriteriaField, getCriterion, getCriterion, getCursorPosition, getCustomState, getDataPath, getDateFormatter, getDecimalPad, getDecimalPrecision, getDefaultIconSrc, getDefaultOperator, getDefaultValue, getDestroyed, getDisabled, getDisabledHover, getDisableIconsOnReadOnly, getDisplayField, getDisplayFieldName, getDisplayValue, getDisplayValue, getEditorTypeConfig, getEditPendingCSSText, getEmptyDisplayValue, getEmptyValueIcon, getErrorIconHeight, getErrorIconProperties, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getErrors, getEscapeHTML, getExportFormat, getFetchMissingValues, getFieldName, getFilterLocally, getForeignDisplayField, getForm, getFormat, getFormItemAutoChild, getFormula, getFullDataPath, getGlobalTabIndex, getGridColNum, getGridRowNum, getHidden, getHint, getHintStyle, getHoverAlign, getHoverDelay, getHoverFocusKey, getHoverHeight, getHoverHeightAsString, getHoverOpacity, getHoverPersist, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWidthAsString, getIcon, getIconBaseStyle, getIconHeight, getIconHSpace, getIconPageRect, getIconPrompt, getIconRect, getIcons, getIconTabPosition, getIconVAlign, getIconWidth, getID, getImageURLPrefix, getImageURLSuffix, getImplicitSave, getImplicitSaveOnBlur, getInputFormat, getLeft, getLinearColSpan, getLinearColSpanAsString, getLinearEndRow, getLinearEndRowAsString, getLinearStartRow, getLinearStartRowAsString, getLinearWidth, getLinearWidthAsString, getListGrid, getLoadingDisplayValue, getLocateItemBy, getMinHintWidth, getMultipleValueSeparator, getName, getNullOriginalValueText, getOperator, getOptionCriteria, getOptionDataSource, getOptionDataSourceAsString, getOptionFilterContext, getOptionOperationId, getOptionTextMatchStyle, getOriginalValueMessage, getPageLeft, getPageRect, getPageTop, getPaletteDefaults, getPicker, getPickerIcon, getPickerIcon, getPickerIconHeight, getPickerIconName, getPickerIconPrompt, getPickerIconProperties, getPickerIconSrc, getPickerIconStyle, getPickerIconTabPosition, getPickerIconWidth, getPixelHeight, getPixelWidth, getPrintReadOnlyTextBoxStyle, getPrintTextBoxStyle, getPrintTitleStyle, getReadOnlyCanSelectText, getReadOnlyControlStyle, getReadOnlyDisplay, getReadOnlyHover, getReadOnlyTextBoxStyle, getReadOnlyWhen, getRect, getRedrawOnChange, getRejectInvalidValueOnChange, getRequired, getRequiredMessage, getRequiredWhen, getRowSpan, getSaveOnEnter, getScClassName, getSelectedRecord, getSelectOnClick, getSelectOnFocus, getShowClippedTitleOnHover, getShowClippedValueOnHover, getShowDeletions, getShowDisabled, getShowDisabledIconsOnFocus, getShowDisabledPickerIconOnFocus, getShowErrorIcon, getShowErrorIconInline, getShowErrorStyle, getShowErrorText, getShowFocused, getShowFocusedErrorState, getShowFocusedIcons, getShowFocusedPickerIcon, getShowHint, getShowIcons, getShowIconsOnFocus, getShowImageAsURL, getShowOldValueInHover, getShowOver, getShowOverIcons, getShowPending, getShowPickerIcon, getShowPickerIconOnFocus, getShowRTL, getShowValueIconOnly, getStaticHeight, getStopOnError, getStoreDisplayValues, getSupportsCutPasteEvents, getSuppressValueIcon, getSynchronousValidation, getTabIndex, getTextAlign, getTextBoxStyle, getTextFormula, getTimeFormatter, getTitle, getTitleAlign, getTitleColSpan, getTitleOrientation, getTitleStyle, getTitleVAlign, getTooltip, getTop, getType, getUpdateControlOnOver, getUpdatePickerIconOnOver, getUpdateTextBoxOnOver, getUseAdvancedCriteria, getUseDisabledHintStyleForReadOnly, getUseLocalDisplayFieldValue, getValidateOnChange, getValidateOnExit, getValidOperators, getVAlign, getValue, getValueAsFloat, getValueAsInteger, getValueAsLong, getValueAsRecordList, getValueDeselectedCSSText, getValueField, getValueFieldName, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getValueMap, getValueMapAsArray, getVisible, getVisibleHeight, getVisibleTitleWidth, getVisibleWhen, getVisibleWidth, getWarnOnEditorTypeConversion, getWarnOnEditorTypeConversionDefault, getWidth, getWidthAsString, getWrapHintText, getWrapStaticValue, getWrapTitle, handleWarnOnEditorTypeConversion, hasErrors, hide, hideIcon, invalidateDisplayValueCache, isAssignableFrom, isConfigOnly, isCreated, isCutEvent, isDisabled, isDrawn, isInGrid, isPasteEvent, isVisible, linkToInstanceUponCreate, mapDisplayToValue, mapValueToDisplay, mapValueToDisplay, mapValueToDisplay, redraw, redraw, removeIcon, selectedRecordChanged, setAccessKey, setAlign, setAllowExpressions, setAlwaysFetchMissingValues, setAlwaysShowControlBox, 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, setAutoCompleteKeywords, setBrowserInputType, setBrowserSpellCheck, setCanEdit, setCanEditOpaqueValues, setCanFocus, setCanHover, setCanSelectText, setCanTabToIcons, setCellHeight, setCellStyle, setChangeOnKeypress, setClipStaticValue, setClipTitle, setColSpan, setColSpan, setConfigOnly, setControlStyle, setCriteriaField, setCriterion, setCustomStateGetter, setDataPath, setDateFormatter, setDecimalPad, setDecimalPrecision, setDefaultIconSrc, setDefaultOperator, setDefaultProperties, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDisabled, setDisabledHover, setDisableIconsOnReadOnly, setDisplayField, setDisplayFormat, setDisplayFormat, setEditorProperties, setEditorType, setEditorType, setEditorType, setEditorValueFormatter, setEditorValueParser, setEditPendingCSSText, setEmptyDisplayValue, setEmptyValueIcon, setErrorFormatter, setErrorIconHeight, setErrorIconProperties, setErrorIconSrc, setErrorIconWidth, setErrorMessageWidth, setErrorOrientation, setErrors, setErrors, setEscapeHTML, setExportFormat, setFetchMissingValues, setFilterLocally, setForeignDisplayField, setFormat, setFormula, setGlobalTabIndex, setHidden, setHint, setHintStyle, setHoverAlign, setHoverDelay, setHoverFocusKey, setHoverHeight, setHoverHeight, setHoverOpacity, setHoverPersist, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWidth, setIconBaseStyle, setIconDisabled, setIconHeight, setIconHSpace, setIconPrompt, setIcons, setIconShowOnFocus, setIconVAlign, setIconWidth, setID, setImageURLPrefix, setImageURLSuffix, setImplicitSave, setImplicitSaveOnBlur, setInitHandler, setInputFormat, setInputTransformer, setItemHoverFormatter, setItemTitleHoverFormatter, setItemValueHoverFormatter, setJavaScriptObject, setLeft, setLinearColSpan, setLinearColSpan, setLinearEndRow, setLinearEndRow, setLinearStartRow, setLinearStartRow, setLinearWidth, setLinearWidth, setLoadingDisplayValue, setLocateItemBy, setMinHintWidth, setMultipleValueSeparator, setName, setNullOriginalValueText, setNullProperty, setOperator, setOptionCriteria, setOptionDataSource, setOptionDataSource, setOptionFilterContext, setOptionOperationId, setOptionTextMatchStyle, setOriginalValueMessage, setPickerIconHeight, setPickerIconName, setPickerIconPrompt, setPickerIconProperties, setPickerIconSrc, setPickerIconStyle, setPickerIconWidth, setPrintReadOnlyTextBoxStyle, setPrintTextBoxStyle, setPrintTitleStyle, setProperty, setProperty, setProperty, setProperty, setProperty, setReadOnlyCanSelectText, setReadOnlyControlStyle, setReadOnlyDisplay, setReadOnlyHover, setReadOnlyTextBoxStyle, setReadOnlyWhen, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRequiredMessage, setRequiredWhen, setRowSpan, setSaveOnEnter, setScClassName, setSelectOnClick, setSelectOnFocus, setShowClippedTitleOnHover, setShowClippedValueOnHover, setShowDeletions, setShowDisabled, setShowDisabledIconsOnFocus, setShowDisabledPickerIconOnFocus, setShowErrorIcon, setShowErrorIconInline, setShowErrorStyle, setShowErrorText, setShowFocused, setShowFocusedErrorState, setShowFocusedIcons, setShowFocusedPickerIcon, setShowHint, setShowIcons, setShowIconsOnFocus, setShowIfCondition, setShowImageAsURL, setShowOldValueInHover, setShowOver, setShowOverIcons, setShowPending, setShowPickerIcon, setShowPickerIconOnFocus, setShowRTL, setShowValueIconOnly, setStateCustomizer, setStaticHeight, setStopOnError, setStoreDisplayValues, setSupportsCutPasteEvents, setSuppressValueIcon, setSynchronousValidation, setTabIndex, setTextAlign, setTextBoxStyle, setTextFormula, setTimeFormatter, setTitle, setTitleAlign, setTitleColSpan, setTitleHoverFormatter, setTitleOrientation, setTitleStyle, setTitleVAlign, setTooltip, setTop, setType, setUpdateControlOnOver, setUpdatePickerIconOnOver, setUpdateTextBoxOnOver, setUseAdvancedCriteria, setUseDisabledHintStyleForReadOnly, setUseLocalDisplayFieldValue, setUseObjectFactoryForTypeFallback, 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, setVisibleWhen, setWarnOnEditorTypeConversion, setWarnOnEditorTypeConversionDefault, setWidth, setWidth, setWrapHintText, setWrapStaticValue, setWrapTitle, shouldApplyHeightToTextBox, shouldFetchMissingValue, shouldSaveOnEnter, shouldStopKeyPressBubbling, show, showIcon, showPicker, stopHover, storeValue, updateState, validate, valueClipped

Methods inherited from class com.smartgwt.client.data.Field

getCanExport, getExportTitle, getSortByField, setCanExport, setExportTitle, setSortByField

Methods inherited from class com.smartgwt.client.core.RefDataClass

getRef, getRef, internalSetID

Methods inherited from class com.smartgwt.client.core.DataClass

applyFactoryProperties, doAddHandler, fireEvent, getAttributeAsDoubleArray, getAttributeAsElement, getAttributeAsIntArray, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreated

Methods inherited from class com.smartgwt.client.core.JsObject

equals, getJsObj, hashCode, setJsObj

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Constructor Detail

ToolbarItem

public ToolbarItem()

ToolbarItem

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

ToolbarItem

public ToolbarItem(java.lang.String name)

ToolbarItem

public ToolbarItem(java.lang.String name,
                   java.lang.String title)

Method Detail

getOrCreateRef

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

changeAutoChildDefaults

public static void changeAutoChildDefaults(java.lang.String autoChildName,
                                           Canvas defaults)

Changes the defaults for Canvas AutoChildren named autoChildName.

Parameters:

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.

See Also:

AutoChildUsage

changeAutoChildDefaults

public static void changeAutoChildDefaults(java.lang.String autoChildName,
                                           FormItem defaults)

Changes the defaults for FormItem AutoChildren named autoChildName.

Parameters:

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.

See Also:

AutoChildUsage

changePickerIconDefaults

public static void changePickerIconDefaults(FormItemIcon defaults)

setButtonAutoFit

public ToolbarItem setButtonAutoFit(java.lang.Boolean buttonAutoFit)

Default Button.autoFit for buttons - true by default. Note that autoFit:true buttons will fit to their title regardless of specified width.

Note : This is an advanced setting

Parameters:

buttonAutoFit - New buttonAutoFit value. Default value is true

Returns:

ToolbarItem instance, for chaining setter calls

getButtonAutoFit

public java.lang.Boolean getButtonAutoFit()

Default Button.autoFit for buttons - true by default. Note that autoFit:true buttons will fit to their title regardless of specified width.

Returns:

Current buttonAutoFit value. Default value is true

setButtonBaseStyle

public ToolbarItem setButtonBaseStyle(java.lang.String buttonBaseStyle)

If specified this baseStyle will be applied to the buttons in this toolbar.

Parameters:

buttonBaseStyle - New buttonBaseStyle value. Default value is null

Returns:

ToolbarItem instance, for chaining setter calls

See Also:

CSSStyleName, Appearance overview and related methods

getButtonBaseStyle

public java.lang.String getButtonBaseStyle()

If specified this baseStyle will be applied to the buttons in this toolbar.

Returns:

Current buttonBaseStyle value. Default value is null

See Also:

CSSStyleName, Appearance overview and related methods

setButtons

public ToolbarItem setButtons(StatefulCanvas... buttons)

List of buttons for the toolbar. Each button should be specified as a simple JS object with properties to apply to the button to be displayed. Note that any click stringMethod applied to the button will be passed 2 parameters: form and item.

Parameters:

buttons - New buttons value. Default value is null

Returns:

ToolbarItem instance, for chaining setter calls

See Also:

Form Items

setButtonSpace

public ToolbarItem setButtonSpace(int buttonSpace)

Space between the buttons of this toolbar. Configures the Layout.membersMargin property on the created canvas.

Parameters:

buttonSpace - New buttonSpace value. Default value is 4

Returns:

ToolbarItem instance, for chaining setter calls

See Also:

Appearance overview and related methods

getButtonSpace

public int getButtonSpace()

Space between the buttons of this toolbar. Configures the Layout.membersMargin property on the created canvas.

Returns:

Current buttonSpace value. Default value is 4

See Also:

Appearance overview and related methods

getCanvas

public Canvas getCanvas()

This item is an autoChild generated Canvas displayed by the ToolbarItem and is an instance of Toolbar by default.

This component is an AutoChild named "canvas". For an overview of how to use and configure AutoChildren, see Using AutoChildren.

Overrides:

getCanvas in class CanvasItem

Returns:

Current canvas value. Default value is null

setCanvasConstructor

public ToolbarItem setCanvasConstructor(java.lang.String canvasConstructor)

Constructor class for this toolbarItem's canvas.

Note : This is an advanced setting

Parameters:

canvasConstructor - New canvasConstructor value. Default value is Toolbar

Returns:

ToolbarItem instance, for chaining setter calls

getCanvasConstructor

public java.lang.String getCanvasConstructor()

Constructor class for this toolbarItem's canvas.

Returns:

Current canvasConstructor value. Default value is Toolbar

setCreateButtonsOnInit

public ToolbarItem setCreateButtonsOnInit(java.lang.Boolean createButtonsOnInit)

If set to true, causes the toolbar created by this item to create its child buttons during initialization, instead of waiting until draw().

See the corresponding Toolbar attribute for more information.

Parameters:

createButtonsOnInit - New createButtonsOnInit value. Default value is null

Returns:

ToolbarItem instance, for chaining setter calls

getCreateButtonsOnInit

public java.lang.Boolean getCreateButtonsOnInit()

If set to true, causes the toolbar created by this item to create its child buttons during initialization, instead of waiting until draw().

See the corresponding Toolbar attribute for more information.

Returns:

Current createButtonsOnInit value. Default value is null

setEditProxyConstructor

public ToolbarItem setEditProxyConstructor(java.lang.String editProxyConstructor)

Default class used to construct the EditProxy for this component when the component is first placed into edit mode.

Overrides:

setEditProxyConstructor in class FormItem

Parameters:

editProxyConstructor - New editProxyConstructor value. Default value is "ToolbarItemEditProxy"

Returns:

ToolbarItem instance, for chaining setter calls

See Also:

SCClassName

getEditProxyConstructor

public java.lang.String getEditProxyConstructor()

Default class used to construct the EditProxy for this component when the component is first placed into edit mode.

Overrides:

getEditProxyConstructor in class FormItem

Returns:

Current editProxyConstructor value. Default value is "ToolbarItemEditProxy"

See Also:

SCClassName

setEndRow

public ToolbarItem setEndRow(java.lang.Boolean endRow)

these items are in a row by themselves by default

Overrides:

setEndRow in class FormItem

Parameters:

endRow - New endRow value. Default value is true

Returns:

ToolbarItem instance, for chaining setter calls

See Also:

Appearance overview and related methods

getEndRow

public java.lang.Boolean getEndRow()

these items are in a row by themselves by default

Overrides:

getEndRow in class FormItem

Returns:

Current endRow value. Default value is true

See Also:

Appearance overview and related methods

setShowTitle

public ToolbarItem setShowTitle(java.lang.Boolean showTitle)

Don't show a title for toolbars

Overrides:

setShowTitle in class FormItem

Parameters:

showTitle - New showTitle value. Default value is false

Returns:

ToolbarItem instance, for chaining setter calls

See Also:

Appearance overview and related methods

getShowTitle

public java.lang.Boolean getShowTitle()

Don't show a title for toolbars

Overrides:

getShowTitle in class FormItem

Returns:

Current showTitle value. Default value is false

See Also:

Appearance overview and related methods

setStartRow

public ToolbarItem setStartRow(java.lang.Boolean startRow)

these items are in a row by themselves by default

Overrides:

setStartRow in class FormItem

Parameters:

startRow - New startRow value. Default value is true

Returns:

ToolbarItem instance, for chaining setter calls

See Also:

Appearance overview and related methods

getStartRow

public java.lang.Boolean getStartRow()

these items are in a row by themselves by default

Overrides:

getStartRow in class FormItem

Returns:

Current startRow value. Default value is true

See Also:

Appearance overview and related methods

setVertical

public ToolbarItem setVertical(java.lang.Boolean vertical)

Should the toolbar stack its buttons vertically or horizontally?

Note : This is an advanced setting

Parameters:

vertical - New vertical value. Default value is false

Returns:

ToolbarItem instance, for chaining setter calls

getVertical

public java.lang.Boolean getVertical()

Should the toolbar stack its buttons vertically or horizontally?

Returns:

Current vertical value. Default value is false

setDefaultProperties

public static void setDefaultProperties(ToolbarItem toolbarItemProperties)

Class level method to set the default properties of this class. If set, then all existing and subsequently created instances of this class will automatically have default properties corresponding to the properties of the class instance passed to this function. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.

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.

Parameters:

toolbarItemProperties - properties that should be used as new defaults when instances of this class are created

See Also:

SGWTProperties