com.alkacon.geranium.client.ui.input

Class SelectBox

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Composite

com.alkacon.geranium.client.ui.input.A_SelectBox<LabelSelectCell>

com.alkacon.geranium.client.ui.input.SelectBox

All Implemented Interfaces:

I_HasInit, I_Truncable, I_FormWidget, I_HasGhostValue, 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

public class SelectBox
extends A_SelectBox<LabelSelectCell>
implements I_HasInit, I_HasGhostValue

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

Nested Class Summary

Nested classes/interfaces inherited from class com.alkacon.geranium.client.ui.input.A_SelectBox

A_SelectBox.I_SelectBoxUiBinder

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 com.alkacon.geranium.client.ui.input.I_FormWidget

I_FormWidget.FieldType

Field Summary

Fields

Modifier and Type	Field and Description
protected Label	m_openerWidget The widget displayed in the opener.
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 com.alkacon.geranium.client.ui.input.A_SelectBox

CSS, m_error, m_eventBus, 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 and Description
SelectBox() Default constructor.
SelectBox(java.util.Map<java.lang.String,java.lang.String> items) Constructs a new select box from a map.
SelectBox(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

Methods

Modifier and Type	Method and Description
void	addOption(java.lang.String value, java.lang.String text) Adds a new selection cell.
protected LabelSelectCell	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. either the real value if available, or else the ghost value if available, or null otherwise.
protected void	initOpener() The implementation of this method should initialize the opener of the select box.
void	setAutoHideParent(I_AutoHider autoHideParent) Call this when auto hiding parents are shown.
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	setItems(java.util.Map<java.lang.String,java.lang.String> items) Sets the items using a map from option values to label texts.
void	setTextForNullSelection(java.lang.String text) Sets the text that is used for the "not selected" option.
void	truncateOpener(java.lang.String prefix, int width) Abstract method whose implementation should truncate the opener widget(s).
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.

Methods inherited from class com.alkacon.geranium.client.ui.input.A_SelectBox

addOption, addValueChangeHandler, clearItems, close, doClickOpener, getFieldType, getFormValue, getFormValueAsString, initMaxCellWidth, isEnabled, onBrowserEvent, onValueSelect, open, reset, selectValue, setEnabled, setErrorMessage, setFormValue, setFormValueAsString, truncate

Methods inherited from class com.google.gwt.user.client.ui.Composite

claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onAttach, onDetach, 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, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

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, unsinkEvents

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 Detail

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_openerWidget

protected Label m_openerWidget

The widget displayed in the opener.

Constructor Detail

SelectBox

public SelectBox()

Default constructor.

SelectBox

public SelectBox(java.util.Map<java.lang.String,java.lang.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

SelectBox

public SelectBox(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 options

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

Method Detail

addOption

public void addOption(java.lang.String value,
             java.lang.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

getApparentValue

public java.lang.String getApparentValue()

Description copied from interface: I_FormWidget

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_FormWidget

Returns:

the apparent value

See Also:

I_FormWidget.getApparentValue()

setAutoHideParent

public void setAutoHideParent(I_AutoHider autoHideParent)

Description copied from interface: I_FormWidget

Call this when auto hiding parents are shown.

Specified by:

setAutoHideParent in interface I_FormWidget

Parameters:

autoHideParent - the auto hide parent

See Also:

I_FormWidget.setAutoHideParent(com.alkacon.geranium.client.ui.I_AutoHider)

setGhostMode

public void setGhostMode(boolean ghostMode)

Description copied from interface: I_HasGhostValue

Enables or disables ghost mode, if possible.

Specified by:

setGhostMode in interface I_HasGhostValue

Parameters:

ghostMode - if ghost mode should be enabled, else disabled

See Also:

I_HasGhostValue.setGhostMode(boolean)

setGhostValue

public void setGhostValue(java.lang.String value,
                 boolean ghostMode)

Description copied from interface: I_HasGhostValue

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_HasGhostValue

Parameters:

value - the ghost value

ghostMode - if true, sets the widget to ghost mode

See Also:

I_HasGhostValue.setGhostValue(java.lang.String, boolean)

setItems

public void setItems(java.util.Map<java.lang.String,java.lang.String> items)

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

Parameters:

items - the map containing the select options

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

truncateOpener

public void truncateOpener(java.lang.String prefix,
                  int width)

Description copied from class: A_SelectBox

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

Specified by:

truncateOpener in class A_SelectBox<LabelSelectCell>

Parameters:

prefix - the text metrics prefix

width - the widget width

See Also:

A_SelectBox.truncateOpener(java.lang.String, int)

createUnknownOption

protected LabelSelectCell createUnknownOption(java.lang.String value)

Description copied from class: A_SelectBox

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

Specified by:

createUnknownOption in class A_SelectBox<LabelSelectCell>

Parameters:

value - the value for which to create the option

Returns:

the new option

See Also:

A_SelectBox.createUnknownOption(java.lang.String)

initOpener

protected void initOpener()

Description copied from class: A_SelectBox

The implementation of this method should initialize the opener of the select box.

Specified by:

initOpener in class A_SelectBox<LabelSelectCell>

See Also:

A_SelectBox.initOpener()

updateOpener

protected void updateOpener(java.lang.String newValue)

Description copied from class: A_SelectBox

The implementation of this method should update the opener when a new value is selected by the user.

Specified by:

updateOpener in class A_SelectBox<LabelSelectCell>

Parameters:

newValue - the value selected by the user

See Also:

A_SelectBox.updateOpener(java.lang.String)