Package org.opencms.gwt.client.ui.input

Class CmsComboBox

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<CmsLabelSelectCell>

org.opencms.gwt.client.ui.input.CmsComboBox

All Implemented Interfaces:

com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasValueChangeHandlers<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_CmsHasPlaceholder, I_CmsFormWidget, I_CmsHasGhostValue

Direct Known Subclasses:

CmsPropertyComboBox

public class CmsComboBox
extends A_CmsSelectBox<CmsLabelSelectCell>
implements I_CmsHasInit, I_CmsHasGhostValue, I_CmsHasPlaceholder

Widget for selecting one of multiple items from a drop-down list which opens after the user clicks on the widget.

Since:

8.0.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
static final String	CSS_CLASS	CSS style name for combo boxes.
protected String	m_ghostValue	The ghost value.
protected CmsSimpleTextBox	m_openerWidget	The widget displayed in the opener.
static final String	NO_SELECTION_OPENER_TEXT	The key for the text which should be displayed in the opener if no option is available.
static final 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

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor	Description
CmsComboBox()	Default constructor.
CmsComboBox(Map<String,String> items)	Constructs a new select box from a map.
CmsComboBox(Map<String,String> items, boolean addNullOption)	Creates a new select box, with the option of adding a "not selected" choice.

Method Summary

Modifier and Type	Method	Description
void	addOption(String value, String text)	Adds a new selection cell.
com.google.gwt.event.shared.HandlerRegistration	addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<String> handler)
void	closeSelector()
protected CmsLabelSelectCell	createUnknownOption(String value)	Internal method to create a select option for an unknown value.
String	getApparentValue()	Returns the "apparent value", i.e.
Object	getFormValue()	Gets the selected/entered value from the widget.
String	getFormValueAsString()	Gets the current value of the widget as a string.
com.google.gwt.user.client.ui.Panel	getMainPanel()	Returns the mainpanel of this widget.
com.google.gwt.user.client.ui.FocusPanel	getOpener()	Returns the opener of this widget.
com.google.gwt.user.client.ui.TextBox	getTextBox()	Returns the text box of this widget.
protected String	getTitle(String option, 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	openSelector()
void	selectValue(String value)	Helper method to set the current selected option.
void	setAutoHideParent(I_CmsAutoHider autoHideParent)	Call this when auto hiding parents are shown.
void	setFormValue(Object value)	Sets the form value of this select box.
void	setFormValueAsString(String formValue)	Sets the current value of the widget as a string.
void	setGhostMode(boolean ghostMode)	Enables or disables ghost mode, if possible.
void	setGhostValue(String value, boolean ghostMode)	Sets the "ghost value" of the widget and optionally sets it to "ghost mode".
void	setItems(Map<String,String> items)	Sets the items using a map from option values to label texts.
void	setPlaceholder(String placeholder)	Sets the placeholder in the widget.
void	setText(String text)	Sets the title for a select option.
void	setTextForNullSelection(String text)	Sets the text that is used for the "not selected" option.
void	setTitle(String option, String title)	Sets the title for a select option.
void	truncateOpener(String prefix, int width)	Abstract method whose implementation should truncate the opener widget(s).
protected void	updateCell(CmsLabelSelectCell cell)	Updates the select cell.
void	updateCells()	Updates the select cells.
protected void	updateOpener(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, addOption, addWidget, clearItems, close, displayingAbove, doClickOpener, getFieldType, getPopupHeight, getSelectorPopup, initPreferredPopupWidth, isEnabled, onBrowserEvent, onDetach, onFocus, onUnload, onValueSelect, onValueSelect, open, removeWindowResizeHandler, reset, setEnabled, setErrorMessage, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

fireEvent

Field Details

CSS_CLASS

public static final String CSS_CLASS

CSS style name for combo boxes.

NO_SELECTION_OPENER_TEXT

public static final 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 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 String m_ghostValue

The ghost value.

m_openerWidget

protected CmsSimpleTextBox m_openerWidget

The widget displayed in the opener.

Constructor Details

CmsComboBox

public CmsComboBox()

Default constructor.

CmsComboBox

public CmsComboBox(Map<String,String> items)

Constructs a new select box from a map.

The keys of the map are the values of the select options, and the values of the map are the labels to be displayed for each option.

Parameters:

items - the map of select options

CmsComboBox

public CmsComboBox(Map<String,String> items,
 boolean addNullOption)

Creates a new select box, with the option of adding a "not selected" choice.

Parameters:

items - the map of select options

addNullOption - if true, a "not selected" option will be added to the select box

Method Details

initClass

public static void initClass()

Initializes this class.

addOption

public void addOption(String value,
 String text)

Adds a new selection cell.

Parameters:

value - the value of the select option

text - the text to be displayed for the select option

addValueChangeHandler

public com.google.gwt.event.shared.HandlerRegistration addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<String> handler)

Specified by:

addValueChangeHandler in interface com.google.gwt.event.logical.shared.HasValueChangeHandlers<String>

Overrides:

addValueChangeHandler in class A_CmsSelectBox<CmsLabelSelectCell>

See Also:

• A_CmsSelectBox.addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler)

closeSelector

public void closeSelector()

getApparentValue

public 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 interface I_CmsFormWidget

Returns:

the apparent value

See Also:

• I_CmsFormWidget.getApparentValue()

getFormValue

public Object getFormValue()

Description copied from interface: I_CmsFormWidget

Gets the selected/entered value from the widget.

Specified by:

getFormValue in interface I_CmsFormWidget

Overrides:

getFormValue in class A_CmsSelectBox<CmsLabelSelectCell>

Returns:

the value

See Also:

• I_CmsFormWidget.getFormValue()

getFormValueAsString

public String getFormValueAsString()

Description copied from interface: I_CmsFormWidget

Gets the current value of the widget as a string.

Specified by:

getFormValueAsString in interface I_CmsFormWidget

Overrides:

getFormValueAsString in class A_CmsSelectBox<CmsLabelSelectCell>

Returns:

the current value of the widget

See Also:

• I_CmsFormWidget.getFormValueAsString()

getMainPanel

public com.google.gwt.user.client.ui.Panel getMainPanel()

Returns the mainpanel of this widget.

Returns:

the mainpanel of this widget

getOpener

public com.google.gwt.user.client.ui.FocusPanel getOpener()

Returns the opener of this widget.

Returns:

the opener of this widget

getTextBox

public com.google.gwt.user.client.ui.TextBox getTextBox()

Returns the text box of this widget.

Returns:

the text box of this widget

openSelector

public void openSelector()

selectValue

public void selectValue(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 class A_CmsSelectBox<CmsLabelSelectCell>

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 interface I_CmsFormWidget

Parameters:

autoHideParent - the auto hide parent

See Also:

• I_CmsFormWidget.setAutoHideParent(org.opencms.gwt.client.ui.I_CmsAutoHider)

setFormValue

public void setFormValue(Object value)

Description copied from class: A_CmsSelectBox

Sets the form value of this select box.

Overrides:

setFormValue in class A_CmsSelectBox<CmsLabelSelectCell>

Parameters:

value - the new value

See Also:

• A_CmsSelectBox.setFormValue(java.lang.Object)

setFormValueAsString

public void setFormValueAsString(String formValue)

Description copied from interface: I_CmsFormWidget

Sets the current value of the widget as a string.

Specified by:

setFormValueAsString in interface I_CmsFormWidget

Overrides:

setFormValueAsString in class A_CmsSelectBox<CmsLabelSelectCell>

Parameters:

formValue - the new value of the widget

See Also:

• I_CmsFormWidget.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 interface I_CmsHasGhostValue

Parameters:

ghostMode - if ghost mode should be enabled, else disabled

See Also:

• I_CmsHasGhostValue.setGhostMode(boolean)

setGhostValue

public void setGhostValue(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 interface I_CmsHasGhostValue

Parameters:

value - the ghost value

ghostMode - if true, sets the widget to ghost mode

See Also:

• I_CmsHasGhostValue.setGhostValue(java.lang.String, boolean)

setItems

public void setItems(Map<String,String> items)

Sets the items using a map from option values to label texts.

Parameters:

items - the map containing the select options

setPlaceholder

public void setPlaceholder(String placeholder)

Description copied from interface: I_CmsHasPlaceholder

Sets the placeholder in the widget.

This *should* be called before the widget is actually attached to the DOM, as it is required by some of the implementations.

Specified by:

setPlaceholder in interface I_CmsHasPlaceholder

Parameters:

placeholder - the placeholder string (null or empty for no placeholder)

See Also:

• I_CmsHasPlaceholder.setPlaceholder(java.lang.String)

setText

public void setText(String text)

Sets the title for a select option.

Note: This will only affect select options added *after* calling this method!

Parameters:

text - the new title for the option

setTextForNullSelection

public void setTextForNullSelection(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(String option,
 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 value

title - the new title for the option

truncateOpener

public void truncateOpener(String prefix,
 int width)

Description copied from class: A_CmsSelectBox

Abstract method whose implementation should truncate the opener widget(s).

Specified by:

truncateOpener in class A_CmsSelectBox<CmsLabelSelectCell>

Parameters:

prefix - the text metrics prefix

width - the widget width

See Also:

• A_CmsSelectBox.truncateOpener(java.lang.String, int)

updateCells

public void updateCells()

Updates the select cells.

createUnknownOption

protected CmsLabelSelectCell createUnknownOption(String value)

Description copied from class: A_CmsSelectBox

Internal method to create a select option for an unknown value.

Specified by:

createUnknownOption in class A_CmsSelectBox<CmsLabelSelectCell>

Parameters:

value - the value for which to create the option

Returns:

the new option

See Also:

• A_CmsSelectBox.createUnknownOption(java.lang.String)

getTitle

protected String getTitle(String option,
 String defaultValue)

Helper method to get the title for a given select option.

Parameters:

option - the select option value

defaultValue - 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 class A_CmsSelectBox<CmsLabelSelectCell>

See Also:

• A_CmsSelectBox.initOpener()

onLoad

protected void onLoad()

Overrides:

onLoad in class A_CmsSelectBox<CmsLabelSelectCell>

See Also:

• Widget.onLoad()

updateCell

protected void updateCell(CmsLabelSelectCell cell)

Updates the select cell.

Parameters:

cell - the select cell

updateOpener

protected void updateOpener(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 class A_CmsSelectBox<CmsLabelSelectCell>

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.