public class MultiComboBoxItem extends CanvasItem
layoutStyle
attribute. The
buttons will be kept in the order that they were added, with the most recently added button being adjacent to the combo
box. MultiComboBoxItem uses the AutoChild pattern to construct the combo box and the buttons so that they can be easily
customized.ComboBoxItem
id
Constructor and Description |
---|
MultiComboBoxItem() |
MultiComboBoxItem(com.google.gwt.core.client.JavaScriptObject jsObj) |
MultiComboBoxItem(java.lang.String name) |
MultiComboBoxItem(java.lang.String name,
java.lang.String title) |
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 |
getAutoFetchData()
Should the MultiComboBoxItem fetch data from the
data source immediately or wait until the
user first opens the pickList. |
java.lang.Boolean |
getAutoFitButtons()
Specifies whether to autofit the buttons in the MultiComboBoxItem.
|
IButton |
getButtonDefaults()
Default properties to be used in creating each
IButton . |
IButton |
getButtonProperties()
Properties to be used in creating each option button.
|
ComboBoxItem |
getComboBoxDefaults()
Default properties for the
ComboBoxItem in a MultiComboBoxItem. |
ComboBoxItem |
getComboBoxProperties()
Properties to be used in creating a
ComboBoxItem . |
java.lang.Integer |
getComboBoxWidth()
Specifies the size of the combo box field.
|
java.lang.String |
getDisplayField()
The
displayField of the combo box. |
MultiComboBoxLayoutStyle |
getLayoutStyle()
Specifies the layout style of the combo box and the buttons in the MultiComboBoxItem.
|
DataSource |
getOptionDataSource()
The
optionDataSource of the combo box. |
static MultiComboBoxItem |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
java.lang.Boolean |
getShouldSaveValue()
Should this item's value be saved in the form's values and hence returned from
form.getValues() ? |
java.lang.Boolean |
getUseInsertionOrder()
Specifies whether to arrange the buttons of the MultiComboBoxItem in the order that they were selected (the default), or
to sort the buttons by
displayField . |
java.lang.String |
getValueField()
The
valueField of the combo box. |
java.lang.String[] |
getValues() |
void |
setAutoFetchData(java.lang.Boolean autoFetchData)
Should the MultiComboBoxItem fetch data from the
data source immediately or wait until the
user first opens the pickList. |
void |
setAutoFitButtons(java.lang.Boolean autoFitButtons)
Specifies whether to autofit the buttons in the MultiComboBoxItem.
|
void |
setButtonProperties(IButton buttonProperties)
Properties to be used in creating each option button.
|
void |
setComboBoxProperties(ComboBoxItem comboBoxProperties)
Properties to be used in creating a
ComboBoxItem . |
void |
setComboBoxWidth(java.lang.Integer comboBoxWidth)
Specifies the size of the combo box field.
|
static void |
setDefaultProperties(MultiComboBoxItem multiComboBoxItemProperties)
Class level method to set the default properties of this class.
|
void |
setDisplayField(java.lang.String displayField)
The
displayField of the combo box. |
void |
setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj) |
void |
setLayoutStyle(MultiComboBoxLayoutStyle layoutStyle)
Specifies the layout style of the combo box and the buttons in the MultiComboBoxItem.
|
void |
setOptionDataSource(DataSource optionDataSource)
The
optionDataSource of the combo box. |
void |
setShouldSaveValue(java.lang.Boolean shouldSaveValue)
Should this item's value be saved in the form's values and hence returned from
form.getValues() ? |
void |
setUseInsertionOrder(java.lang.Boolean useInsertionOrder)
Specifies whether to arrange the buttons of the MultiComboBoxItem in the order that they were selected (the default), or
to sort the buttons by
displayField . |
void |
setValueField(java.lang.String valueField)
The
valueField of the combo box. |
void |
setValues(java.lang.Object... values) |
void |
showValue(java.lang.Object displayValue,
java.lang.Object dataValue,
DynamicForm form,
CanvasItem item)
This method will be called whenever this form item's value is being set via a programmatic call to e.g:
DynamicForm.setValues or FormItem.setValue and may be overridden by CanvasItems
intended to support displaying data values to update the embedded Canvas to reflect the value passed in. |
addCanEditChangedHandler, addShowValueHandler, createCanvas, getApplyPromptToCanvas, getAutoDestroy, getCanvas, getEditCriteriaInInnerForm, getHeight, getMultiple, getOverflow, getPrompt, hasAdvancedCriteria, readOnlyDisplayChanged, setApplyPromptToCanvas, setAutoDestroy, setCanEditCriterionPredicate, setCanvas, setCriterionGetter, setCriterionSetter, setDefaultProperties, setEditCriteriaInInnerForm, setMultiple, setOverflow, setPrompt, setupCanvasConstructor, storeValue, storeValue, storeValue
_getValue, addBlurHandler, addChangedHandler, addChangeHandler, addClickHandler, addDoubleClickHandler, addEditorEnterHandler, addEditorExitHandler, addFocusHandler, addIconClickHandler, addIconKeyPressHandler, addItemHoverHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addPickerIconClickHandler, addTitleClickHandler, addTitleDoubleClickHandler, addTitleHoverHandler, addValueHoverHandler, asSGWTComponent, blurItem, canEditCriterion, clearValue, disable, enable, focusInItem, getAccessKey, getAlign, getAllowExpressions, getAlwaysFetchMissingValues, getApplyHeightToTextBox, getAriaRole, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsString, getBrowserSpellCheck, getCanEdit, getCanFocus, getCanvasAutoChild, getCellHeight, getCellStyle, getClassName, getClipStaticValue, getClipTitle, getConfig, getContainerWidget, getCriteriaField, getCriterion, getCriterion, getDataPath, getDateFormatter, getDecimalPad, getDecimalPrecision, getDefaultIconSrc, getDisabled, getDisableIconsOnReadOnly, getDisplayFieldName, getDisplayValue, getDisplayValue, getEditorTypeConfig, getEditPendingCSSText, getEmptyDisplayValue, getEmptyValueIcon, getEndRow, getErrorIconHeight, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getFetchMissingValues, getFieldName, getFilterLocally, getForm, getFormItemAutoChild, getFullDataPath, getGlobalTabIndex, getHint, getHintStyle, getHoverAlign, getHoverDelay, getHoverHeight, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getIcon, getIconHeight, getIconHSpace, getIconPageRect, getIconPrompt, getIconRect, getIconVAlign, getIconWidth, getImageURLPrefix, getImageURLSuffix, getImplicitSave, getImplicitSaveOnBlur, getInputFormat, getLeft, getLocateItemBy, getMultipleValueSeparator, getName, getOperator, getOptionCriteria, getOptionFilterContext, getOptionOperationId, getPageLeft, getPageRect, getPageTop, getPicker, getPickerIconHeight, getPickerIconName, getPickerIconPrompt, getPickerIconProperties, getPickerIconSrc, getPickerIconStyle, getPickerIconWidth, getPrintTextBoxStyle, getPrintTitleStyle, getReadOnlyDisplay, getReadOnlyTextBoxStyle, getRect, getRedrawOnChange, getRejectInvalidValueOnChange, getRequired, getRequiredMessage, getRowSpan, getSaveOnEnter, getSelectedRecord, getSelectOnClick, getSelectOnFocus, getShowClippedTitleOnHover, getShowClippedValueOnHover, getShowDisabled, getShowErrorIcon, getShowErrorStyle, getShowErrorText, getShowFocused, getShowFocusedErrorState, getShowFocusedIcons, getShowFocusedPickerIcon, getShowHint, getShowIcons, getShowOverIcons, getShowPickerIcon, getShowRTL, getShowTitle, getShowValueIconOnly, getStartRow, getStopOnError, getSuppressValueIcon, getSynchronousValidation, getTabIndex, getTextAlign, getTextBoxStyle, getTimeFormatter, getTitle, getTitleAlign, getTitleColSpan, getTitleOrientation, getTitleStyle, getTitleVAlign, getTooltip, getTop, getType, getValidateOnChange, getValidateOnExit, getValidOperators, getVAlign, getValue, getValueAsRecordList, getValueFieldName, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getVisible, getVisibleHeight, getVisibleWidth, getWidth, getWrapTitle, hide, hideIcon, invalidateDisplayValueCache, isCreated, isDisabled, isDrawn, isVisible, redraw, setAccessKey, setAlign, setAllowExpressions, setAlwaysFetchMissingValues, setApplyHeightToTextBox, setAriaRole, setAriaState, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setBrowserSpellCheck, setCanEdit, setCanFocus, setCellHeight, setCellStyle, setClipStaticValue, setClipTitle, setColSpan, setColSpan, setCriteriaField, setCriterion, setDataPath, setDateFormatter, setDecimalPad, setDecimalPrecision, setDefaultIconSrc, setDefaultProperties, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDisabled, setDisableIconsOnReadOnly, setDisplayFormat, setDisplayFormat, setEditorProperties, setEditorType, setEditorType, setEditorType, setEditorValueFormatter, setEditorValueParser, setEditPendingCSSText, setEmptyDisplayValue, setEmptyValueIcon, setEndRow, setErrorFormatter, setErrorIconHeight, setErrorIconSrc, setErrorIconWidth, setErrorMessageWidth, setErrorOrientation, setFetchMissingValues, setFilterLocally, setGlobalTabIndex, setHeight, setHeight, setHint, setHintStyle, setHoverAlign, setHoverDelay, setHoverHeight, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setIconHeight, setIconHSpace, setIconPrompt, setIcons, setIconVAlign, setIconWidth, setImageURLPrefix, setImageURLSuffix, setImplicitSave, setImplicitSaveOnBlur, setInitHandler, setInputFormat, setInputTransformer, setItemHoverFormatter, setItemTitleHoverFormatter, setItemValueHoverFormatter, setLeft, setLocateItemBy, setMultipleValueSeparator, setName, setOperator, setOptionCriteria, setOptionFilterContext, setOptionOperationId, setPickerIconHeight, setPickerIconName, setPickerIconPrompt, setPickerIconProperties, setPickerIconSrc, setPickerIconStyle, setPickerIconWidth, setPrintTextBoxStyle, setPrintTitleStyle, setProperty, setProperty, setProperty, setProperty, setProperty, setReadOnlyDisplay, setReadOnlyTextBoxStyle, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRequiredMessage, setRowSpan, setSaveOnEnter, setSelectOnClick, setSelectOnFocus, setShowClippedTitleOnHover, setShowClippedValueOnHover, setShowDisabled, setShowErrorIcon, setShowErrorStyle, setShowErrorText, setShowFocused, setShowFocusedErrorState, setShowFocusedIcons, setShowFocusedPickerIcon, setShowHint, setShowIcons, setShowIfCondition, setShowOverIcons, setShowPickerIcon, setShowRTL, setShowTitle, setShowValueIconOnly, setStartRow, setStopOnError, setSuppressValueIcon, setSynchronousValidation, setTabIndex, setTextAlign, setTextBoxStyle, setTimeFormatter, setTitle, setTitleAlign, setTitleColSpan, setTitleHoverFormatter, setTitleOrientation, setTitleStyle, setTitleVAlign, setTooltip, setTop, setType, setValidateOnChange, setValidateOnExit, setValidators, setValidOperators, setVAlign, setValue, setValue, setValue, setValue, setValue, setValue, setValueFormatter, setValueHoverFormatter, setValueIconHeight, setValueIconLeftPadding, setValueIconMapper, setValueIconRightPadding, setValueIcons, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setVisible, setWidth, setWidth, setWrapTitle, shouldApplyHeightToTextBox, shouldFetchMissingValue, shouldSaveOnEnter, show, showIcon, showPicker, stopHover, updateState, validate, valueClipped
getRef, getRef, internalSetID
doAddHandler, fireEvent, getAttributeAsDoubleArray, getAttributeAsIntArray, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsStringArray, getAttributes, getHandlerCount, getJsObj, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject
public MultiComboBoxItem()
public MultiComboBoxItem(com.google.gwt.core.client.JavaScriptObject jsObj)
public MultiComboBoxItem(java.lang.String name)
public MultiComboBoxItem(java.lang.String name, java.lang.String title)
public static MultiComboBoxItem getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public void setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj)
setJavaScriptObject
in class CanvasItem
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.AutoChildUsage
public 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.AutoChildUsage
public static void changePickerIconDefaults(FormItemIcon defaults)
public void setAutoFetchData(java.lang.Boolean autoFetchData)
data source
immediately or wait until the
user first opens the pickList.autoFetchData
- autoFetchData Default value is falseComboBoxItem.setAutoFetchData(java.lang.Boolean)
public java.lang.Boolean getAutoFetchData()
data source
immediately or wait until the
user first opens the pickList.ComboBoxItem.getAutoFetchData()
public void setAutoFitButtons(java.lang.Boolean autoFitButtons)
layoutStyle
is "flow", but false for a
layoutStyle of "vertical" or "verticalReverse". If the layoutStyle
is "horizontal" or "horizontalReverse"
then the buttons will autofit regardless of the setting of this property.
autoFitButtons
property.autoFitButtons
- whether to autofit the buttons. Default value is nullpublic java.lang.Boolean getAutoFitButtons()
layoutStyle
is "flow", but false for a
layoutStyle of "vertical" or "verticalReverse". If the layoutStyle
is "horizontal" or "horizontalReverse"
then the buttons will autofit regardless of the setting of this property.public void setComboBoxWidth(java.lang.Integer comboBoxWidth)
Note that this attribute only has an effect in "flow", "horizontal", and
"horizontalReverse" modes
. In the
other modes, the combo box is as wide as the overall MultiComboBoxItem.
comboBoxWidth
- comboBoxWidth Default value is nullpublic java.lang.Integer getComboBoxWidth()
Note that this attribute only has an effect in "flow", "horizontal", and
"horizontalReverse" modes
. In the
other modes, the combo box is as wide as the overall MultiComboBoxItem.
public void setDisplayField(java.lang.String displayField)
displayField
of the combo box.
Note : This is an advanced setting
setDisplayField
in class FormItem
displayField
- . See String
. Default value is nullComboBoxItem.setDisplayField(java.lang.String)
public java.lang.String getDisplayField()
displayField
of the combo box.getDisplayField
in class FormItem
String
ComboBoxItem.getDisplayField()
public void setLayoutStyle(MultiComboBoxLayoutStyle layoutStyle)
layoutStyle
- the new layout style. Default value is "flow"public MultiComboBoxLayoutStyle getLayoutStyle()
public void setShouldSaveValue(java.lang.Boolean shouldSaveValue)
form.getValues()
? shouldSaveValue:false
is used
to mark formItems which do not correspond to the underlying data model and should not save a value into the form's
values
. Example includes visual separators, password
re-type fields, or checkboxes used to show/hide other form items.
A shouldSaveValue:false
item should
be given a value either via defaultValue
or by
calling form.setValue(item, value)
or formItem.setValue(value)
. Providing a value via form.values
or form.setValues()
will automatically switch the item to
shouldSaveValue:true
.
Note that
setShouldSaveValue
in class CanvasItem
shouldSaveValue
- shouldSaveValue Default value is truepublic java.lang.Boolean getShouldSaveValue()
form.getValues()
? shouldSaveValue:false
is used
to mark formItems which do not correspond to the underlying data model and should not save a value into the form's
values
. Example includes visual separators, password
re-type fields, or checkboxes used to show/hide other form items.
A shouldSaveValue:false
item should
be given a value either via defaultValue
or by
calling form.setValue(item, value)
or formItem.setValue(value)
. Providing a value via form.values
or form.setValues()
will automatically switch the item to
shouldSaveValue:true
.
Note that
getShouldSaveValue
in class CanvasItem
public void setUseInsertionOrder(java.lang.Boolean useInsertionOrder)
displayField
.useInsertionOrder
- useInsertionOrder Default value is truepublic java.lang.Boolean getUseInsertionOrder()
displayField
.public void setValueField(java.lang.String valueField)
valueField
of the combo box.setValueField
in class FormItem
valueField
- . See String
. Default value is nullComboBoxItem.setValueField(java.lang.String)
public java.lang.String getValueField()
valueField
of the combo box.getValueField
in class FormItem
String
ComboBoxItem.getValueField()
public void showValue(java.lang.Object displayValue, java.lang.Object dataValue, DynamicForm form, CanvasItem item)
DynamicForm.setValues
or FormItem.setValue
and may be overridden by CanvasItems
intended to support displaying data values to update the embedded Canvas to reflect the value passed in.displayValue
- new display-value for the item. This is the value after applying any custom formatter or valueMapdataValue
- underlying data value for the itemform
- the dynamicForm in which this item is containeditem
- the live form item instancepublic static void setDefaultProperties(MultiComboBoxItem multiComboBoxItemProperties)
Note: This method is intended for setting default attributes only and will effect 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.
multiComboBoxItemProperties
- properties that should be used as new defaults when instances of this class are createdpublic IButton getButtonDefaults()
IButton
.public void setButtonProperties(IButton buttonProperties)
Note : This is an advanced setting
buttonProperties
- buttonPropertiespublic IButton getButtonProperties()
public ComboBoxItem getComboBoxDefaults()
ComboBoxItem
in a MultiComboBoxItem.public void setComboBoxProperties(ComboBoxItem comboBoxProperties)
ComboBoxItem
.
Note : This is an advanced setting
comboBoxProperties
- comboBoxProperties Default value is nullpublic ComboBoxItem getComboBoxProperties()
ComboBoxItem
.public void setOptionDataSource(DataSource optionDataSource)
optionDataSource
of the combo box.setOptionDataSource
in class FormItem
optionDataSource
- optionDataSource Default value is nullComboBoxItem.setOptionDataSource(com.smartgwt.client.data.DataSource)
public DataSource getOptionDataSource()
optionDataSource
of the combo box.ComboBoxItem.getOptionDataSource()
public final java.lang.String[] getValues()
public void setValues(java.lang.Object... values)