Package org.opencms.gwt.client.ui.input
Class CmsMultiSelectBox
- java.lang.Object
-
- com.google.gwt.user.client.ui.UIObject
-
- com.google.gwt.user.client.ui.Widget
-
- com.google.gwt.user.client.ui.Composite
-
- org.opencms.gwt.client.ui.input.A_CmsSelectBox<CmsMultiSelectCell>
-
- org.opencms.gwt.client.ui.input.CmsMultiSelectBox
-
- All Implemented Interfaces:
com.google.gwt.event.dom.client.HasFocusHandlers
,com.google.gwt.event.logical.shared.HasAttachHandlers
,com.google.gwt.event.logical.shared.HasValueChangeHandlers<java.lang.String>
,com.google.gwt.event.shared.HasHandlers
,com.google.gwt.user.client.EventListener
,com.google.gwt.user.client.ui.HasVisibility
,com.google.gwt.user.client.ui.IsRenderable
,com.google.gwt.user.client.ui.IsWidget
,I_CmsHasInit
,I_CmsTruncable
,I_CmsFormWidget
,I_CmsHasGhostValue
public class CmsMultiSelectBox extends A_CmsSelectBox<CmsMultiSelectCell> implements I_CmsHasInit, I_CmsHasGhostValue
Widget for selecting one of multiple items from a drop-down list which opens after the user clicks on the widget.- Since:
- 8.5.0
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.opencms.gwt.client.ui.input.A_CmsSelectBox
A_CmsSelectBox.I_CmsSelectBoxUiBinder
-
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled
-
Nested classes/interfaces inherited from interface org.opencms.gwt.client.ui.input.I_CmsFormWidget
I_CmsFormWidget.FieldType
-
-
Field Summary
Fields Modifier and Type Field Description protected java.lang.String
m_ghostValue
The ghost value.protected CmsLabel
m_openerWidget
The widget displayed in the opener.static java.lang.String
NO_SELECTION_OPENER_TEXT
The key for the text which should be displayed in the opener if no option is available.static java.lang.String
NO_SELECTION_TEXT
The key for the text which should be displayed if no option is available.-
Fields inherited from class org.opencms.gwt.client.ui.input.A_CmsSelectBox
CSS, m_error, m_eventBus, m_mousewheelRegistration, m_openClose, m_opener, m_panel, m_popup, m_selectBoxState, m_selectCells, m_selectedValue, m_selector, m_selectorState
-
-
Constructor Summary
Constructors Constructor Description CmsMultiSelectBox()
Default constructor.CmsMultiSelectBox(java.util.Map<java.lang.String,java.lang.String> items, boolean addNullOption)
Creates a new select box, with the option of adding a "not selected" choice.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addOption(CmsMultiSelectCell cell)
Adds a new selection cell.protected CmsMultiSelectCell
createUnknownOption(java.lang.String value)
Internal method to create a select option for an unknown value.java.lang.String
getApparentValue()
Returns the "apparent value", i.e.java.util.List<CmsCheckBox>
getCheckboxes()
Returns all CmsCheckBoxes used.java.lang.String
getFormValueAsString()
Gets the current value of the widget as a string.protected java.lang.String
getTitle(java.lang.String option, java.lang.String defaultValue)
Helper method to get the title for a given select option.static void
initClass()
Initializes this class.protected void
initOpener()
The implementation of this method should initialize the opener of the select box.protected void
onLoad()
void
selectValue(java.lang.String value)
Helper method to set the current selected option.void
setAutoHideParent(I_CmsAutoHider autoHideParent)
Call this when auto hiding parents are shown.void
setFormValueAsString(java.lang.String value)
Sets the current value of the widget as a string.void
setGhostMode(boolean ghostMode)
Enables or disables ghost mode, if possible.void
setGhostValue(java.lang.String value, boolean ghostMode)
Sets the "ghost value" of the widget and optionally sets it to "ghost mode".void
setTextForNullSelection(java.lang.String text)
Sets the text that is used for the "not selected" option.void
setTitle(java.lang.String option, java.lang.String title)
Sets the title for a select option.void
truncateOpener(java.lang.String prefix, int width)
Abstract method whose implementation should truncate the opener widget(s).void
updateCell(CmsMultiSelectCell cell)
Updates a single select cell.void
updateCells()
Updates the select cells.protected void
updateOpener(java.lang.String newValue)
The implementation of this method should update the opener when a new value is selected by the user.protected void
updateStyle()
This method should be used to make changes to the CSS style of the select box when the value changes.-
Methods inherited from class org.opencms.gwt.client.ui.input.A_CmsSelectBox
addFocusHandler, addValueChangeHandler, addWidget, clearItems, close, displayingAbove, doClickOpener, getFieldType, getFormValue, getPopupHeight, getSelectorPopup, initMaxCellWidth, isEnabled, onBrowserEvent, onDetach, onFocus, onUnload, onValueSelect, onValueSelect, open, removeWindowResizeHandler, reset, setEnabled, setErrorMessage, setFormValue, setFormValue, setPopupResize, truncate
-
Methods inherited from class com.google.gwt.user.client.ui.Composite
claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onAttach, render, render, resolvePotentialElement, setWidget
-
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, removeFromParent, setLayoutData, sinkEvents, unsinkEvents
-
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString
-
-
-
-
Field Detail
-
NO_SELECTION_OPENER_TEXT
public static final java.lang.String NO_SELECTION_OPENER_TEXT
The key for the text which should be displayed in the opener if no option is available.- See Also:
- Constant Field Values
-
NO_SELECTION_TEXT
public static final java.lang.String NO_SELECTION_TEXT
The key for the text which should be displayed if no option is available.- See Also:
- Constant Field Values
-
m_ghostValue
protected java.lang.String m_ghostValue
The ghost value.
-
m_openerWidget
protected CmsLabel m_openerWidget
The widget displayed in the opener.
-
-
Constructor Detail
-
CmsMultiSelectBox
public CmsMultiSelectBox()
Default constructor.
-
CmsMultiSelectBox
public CmsMultiSelectBox(java.util.Map<java.lang.String,java.lang.String> items, boolean addNullOption)
Creates a new select box, with the option of adding a "not selected" choice.- Parameters:
items
- the map of select optionsaddNullOption
- if true, a "not selected" option will be added to the select box
-
-
Method Detail
-
initClass
public static void initClass()
Initializes this class.
-
addOption
public void addOption(CmsMultiSelectCell cell)
Adds a new selection cell.- Overrides:
addOption
in classA_CmsSelectBox<CmsMultiSelectCell>
- Parameters:
cell
- the new selection cell
-
getApparentValue
public java.lang.String getApparentValue()
Description copied from interface:I_CmsFormWidget
Returns the "apparent value", i.e. either the real value if available, or else the ghost value if available, or null otherwise.- Specified by:
getApparentValue
in interfaceI_CmsFormWidget
- Returns:
- the apparent value
- See Also:
I_CmsFormWidget.getApparentValue()
-
getCheckboxes
public java.util.List<CmsCheckBox> getCheckboxes()
Returns all CmsCheckBoxes used.- Returns:
- a list of CmsCheckBoxes
-
getFormValueAsString
public java.lang.String getFormValueAsString()
Description copied from interface:I_CmsFormWidget
Gets the current value of the widget as a string.- Specified by:
getFormValueAsString
in interfaceI_CmsFormWidget
- Overrides:
getFormValueAsString
in classA_CmsSelectBox<CmsMultiSelectCell>
- Returns:
- the current value of the widget
- See Also:
A_CmsSelectBox.getFormValueAsString()
-
selectValue
public void selectValue(java.lang.String value)
Description copied from class:A_CmsSelectBox
Helper method to set the current selected option.This method does not trigger the "value changed" event.
- Overrides:
selectValue
in classA_CmsSelectBox<CmsMultiSelectCell>
- Parameters:
value
- the new value- See Also:
A_CmsSelectBox.selectValue(java.lang.String)
-
setAutoHideParent
public void setAutoHideParent(I_CmsAutoHider autoHideParent)
Description copied from interface:I_CmsFormWidget
Call this when auto hiding parents are shown.- Specified by:
setAutoHideParent
in interfaceI_CmsFormWidget
- Parameters:
autoHideParent
- the auto hide parent- See Also:
I_CmsFormWidget.setAutoHideParent(org.opencms.gwt.client.ui.I_CmsAutoHider)
-
setFormValueAsString
public void setFormValueAsString(java.lang.String value)
Description copied from interface:I_CmsFormWidget
Sets the current value of the widget as a string.- Specified by:
setFormValueAsString
in interfaceI_CmsFormWidget
- Overrides:
setFormValueAsString
in classA_CmsSelectBox<CmsMultiSelectCell>
- Parameters:
value
- the new value of the widget- See Also:
A_CmsSelectBox.setFormValueAsString(java.lang.String)
-
setGhostMode
public void setGhostMode(boolean ghostMode)
Description copied from interface:I_CmsHasGhostValue
Enables or disables ghost mode, if possible.- Specified by:
setGhostMode
in interfaceI_CmsHasGhostValue
- Parameters:
ghostMode
- if ghost mode should be enabled, else disabled- See Also:
I_CmsHasGhostValue.setGhostMode(boolean)
-
setGhostValue
public void setGhostValue(java.lang.String value, boolean ghostMode)
Description copied from interface:I_CmsHasGhostValue
Sets the "ghost value" of the widget and optionally sets it to "ghost mode"."Ghost mode" can be used to show the user the value (called "ghost value") which will be used if he either doesn't choose an option in the widget, or explicitly chooses an "empty" or "default" option.
- Specified by:
setGhostValue
in interfaceI_CmsHasGhostValue
- Parameters:
value
- the ghost valueghostMode
- if true, sets the widget to ghost mode- See Also:
I_CmsHasGhostValue.setGhostValue(java.lang.String, boolean)
-
setTextForNullSelection
public void setTextForNullSelection(java.lang.String text)
Sets the text that is used for the "not selected" option.- Parameters:
text
- the text which should be used for the "not selected" option
-
setTitle
public void setTitle(java.lang.String option, java.lang.String title)
Sets the title for a select option.Note: This will only affect select options added *after* calling this method!
- Parameters:
option
- the select option valuetitle
- the new title for the option
-
truncateOpener
public void truncateOpener(java.lang.String prefix, int width)
Description copied from class:A_CmsSelectBox
Abstract method whose implementation should truncate the opener widget(s).- Specified by:
truncateOpener
in classA_CmsSelectBox<CmsMultiSelectCell>
- Parameters:
prefix
- the text metrics prefixwidth
- the widget width- See Also:
A_CmsSelectBox.truncateOpener(java.lang.String, int)
-
updateCell
public void updateCell(CmsMultiSelectCell cell)
Updates a single select cell.- Parameters:
cell
- the select cell to update
-
updateCells
public void updateCells()
Updates the select cells.
-
createUnknownOption
protected CmsMultiSelectCell createUnknownOption(java.lang.String value)
Description copied from class:A_CmsSelectBox
Internal method to create a select option for an unknown value.- Specified by:
createUnknownOption
in classA_CmsSelectBox<CmsMultiSelectCell>
- Parameters:
value
- the value for which to create the option- Returns:
- the new option
- See Also:
A_CmsSelectBox.createUnknownOption(java.lang.String)
-
getTitle
protected java.lang.String getTitle(java.lang.String option, java.lang.String defaultValue)
Helper method to get the title for a given select option.- Parameters:
option
- the select option valuedefaultValue
- the value to return when no title for the value was found- Returns:
- the title for the select option
-
initOpener
protected void initOpener()
Description copied from class:A_CmsSelectBox
The implementation of this method should initialize the opener of the select box.- Specified by:
initOpener
in classA_CmsSelectBox<CmsMultiSelectCell>
- See Also:
A_CmsSelectBox.initOpener()
-
onLoad
protected void onLoad()
- Overrides:
onLoad
in classA_CmsSelectBox<CmsMultiSelectCell>
- See Also:
Widget.onLoad()
-
updateOpener
protected void updateOpener(java.lang.String newValue)
Description copied from class:A_CmsSelectBox
The implementation of this method should update the opener when a new value is selected by the user.- Specified by:
updateOpener
in classA_CmsSelectBox<CmsMultiSelectCell>
- Parameters:
newValue
- the value selected by the user- See Also:
A_CmsSelectBox.updateOpener(java.lang.String)
-
updateStyle
protected void updateStyle()
This method should be used to make changes to the CSS style of the select box when the value changes.
-
-