com.alkacon.geranium.client.ui.input

Class A_SelectBox<OPTION extends A_SelectCell>

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

Type Parameters:

OPTION - the widget type of the select options

All Implemented Interfaces:

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

Direct Known Subclasses:

SelectBox

public abstract class A_SelectBox<OPTION extends A_SelectCell>
extends com.google.gwt.user.client.ui.Composite
implements I_FormWidget, com.google.gwt.event.logical.shared.HasValueChangeHandlers<java.lang.String>, I_Truncable

Abstract superclass for select box widgets.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	A_SelectBox.I_SelectBoxUiBinder The UI Binder interface for this widget.

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 static I_InputCss	CSS The layout bundle.
protected ErrorWidget	m_error Error widget.
protected com.google.gwt.event.shared.SimpleEventBus	m_eventBus The event bus.
protected PushButton	m_openClose The open-close button.
protected com.google.gwt.user.client.ui.FocusPanel	m_opener The opener widget.
protected com.google.gwt.user.client.ui.Panel	m_panel Container for the opener and error widget.
protected com.google.gwt.user.client.ui.PopupPanel	m_popup The popup panel inside which the selector will be shown.
protected StyleVariable	m_selectBoxState Style of the select box widget.
protected java.util.Map<java.lang.String,OPTION>	m_selectCells The map of select options.
protected java.lang.String	m_selectedValue The value of the currently selected option.
protected com.google.gwt.user.client.ui.Panel	m_selector The selector which contains the select options.
protected StyleVariable	m_selectorState Style of the select box widget.

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
A_SelectBox() Creates a new select box.

Method Summary

Methods

Modifier and Type	Method and Description
void	addOption(OPTION cell) Adds a new select option to the select box.
com.google.gwt.event.shared.HandlerRegistration	addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<java.lang.String> handler)
protected void	clearItems() Internal helper method for clearing the select options.
protected void	close() Internal method which is called when the selector is closed.
protected abstract OPTION	createUnknownOption(java.lang.String value) Internal method to create a select option for an unknown value.
protected void	doClickOpener(com.google.gwt.event.dom.client.ClickEvent e) Handle clicks on the opener.
I_FormWidget.FieldType	getFieldType() Returns the type of data this widget produces.
java.lang.Object	getFormValue() Gets the selected/entered value from the widget.
java.lang.String	getFormValueAsString() Gets the current value of the widget as a string.
protected void	initMaxCellWidth() Initializes the selector width.
protected abstract void	initOpener() The implementation of this method should initialize the opener of the select box.
boolean	isEnabled() Returns true if this widget is enabled.
void	onBrowserEvent(com.google.gwt.user.client.Event event)
protected void	onValueSelect(java.lang.String value) Internal handler method which is called when a new value is selected.
protected void	open() Internal method which is called when the selector is opened.
void	reset() Resets the widget to its default state.
void	selectValue(java.lang.String value) Helper method to set the current selected option.
void	setEnabled(boolean enabled) Enables or disables the widget.
void	setErrorMessage(java.lang.String errorMessage) Sets the error message for this widget.
void	setFormValue(java.lang.Object value) Sets the form value of this select box.
void	setFormValueAsString(java.lang.String formValue) Sets the current value of the widget as a string.
void	truncate(java.lang.String textMetricsPrefix, int widgetWidth) Truncates long text and sets the original text to the title attribute.
protected abstract void	truncateOpener(java.lang.String prefix, int width) Abstract method whose implementation should truncate the opener widget(s).
protected abstract 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.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, 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.alkacon.geranium.client.ui.input.I_FormWidget

getApparentValue, setAutoHideParent

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

fireEvent

Field Detail

CSS

protected static final I_InputCss CSS

The layout bundle.

m_error

@UiField
protected ErrorWidget m_error

Error widget.

m_eventBus

protected com.google.gwt.event.shared.SimpleEventBus m_eventBus

The event bus.

m_openClose

protected PushButton m_openClose

The open-close button.

m_opener

@UiField
protected com.google.gwt.user.client.ui.FocusPanel m_opener

The opener widget.

m_panel

@UiField
protected com.google.gwt.user.client.ui.Panel m_panel

Container for the opener and error widget.

m_popup

protected com.google.gwt.user.client.ui.PopupPanel m_popup

The popup panel inside which the selector will be shown.

m_selectBoxState

protected final StyleVariable m_selectBoxState

Style of the select box widget.

m_selectCells

protected java.util.Map<java.lang.String,OPTION extends A_SelectCell> m_selectCells

The map of select options.

m_selectedValue

protected java.lang.String m_selectedValue

The value of the currently selected option.

m_selector

protected com.google.gwt.user.client.ui.Panel m_selector

The selector which contains the select options.

m_selectorState

protected final StyleVariable m_selectorState

Style of the select box widget.

Constructor Detail

A_SelectBox

public A_SelectBox()

Creates a new select box.

Method Detail

addOption

public void addOption(OPTION cell)

Adds a new select option to the select box.

Parameters:

cell - the widget representing the select option

addValueChangeHandler

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

Specified by:

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

See Also:

HasValueChangeHandlers.addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler)

getFieldType

public I_FormWidget.FieldType getFieldType()

Description copied from interface: I_FormWidget

Returns the type of data this widget produces.

Specified by:

getFieldType in interface I_FormWidget

Returns:

the data type

See Also:

I_FormWidget.getFieldType()

getFormValue

public java.lang.Object getFormValue()

Description copied from interface: I_FormWidget

Gets the selected/entered value from the widget.

Specified by:

getFormValue in interface I_FormWidget

Returns:

the value

See Also:

I_FormWidget.getFormValue()

getFormValueAsString

public java.lang.String getFormValueAsString()

Description copied from interface: I_FormWidget

Gets the current value of the widget as a string.

Specified by:

getFormValueAsString in interface I_FormWidget

Returns:

the current value of the widget

See Also:

I_FormWidget.getFormValueAsString()

isEnabled

public boolean isEnabled()

Description copied from interface: I_FormWidget

Returns true if this widget is enabled.

Specified by:

isEnabled in interface I_FormWidget

Returns:

true if this widget is enabled

See Also:

I_FormWidget.isEnabled()

onBrowserEvent

public void onBrowserEvent(com.google.gwt.user.client.Event event)

Specified by:

onBrowserEvent in interface com.google.gwt.user.client.EventListener

Overrides:

onBrowserEvent in class com.google.gwt.user.client.ui.Composite

See Also:

Composite.onBrowserEvent(com.google.gwt.user.client.Event)

reset

public void reset()

Description copied from interface: I_FormWidget

Resets the widget to its default state.

Specified by:

reset in interface I_FormWidget

See Also:

I_FormWidget.reset()

selectValue

public void selectValue(java.lang.String value)

Helper method to set the current selected option.

This method does not trigger the "value changed" event.

Parameters:

value - the new value

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: I_FormWidget

Enables or disables the widget.

Specified by:

setEnabled in interface I_FormWidget

Parameters:

enabled - if true, the widget will be enabled, else disabled

See Also:

I_FormWidget.setEnabled(boolean)

setErrorMessage

public void setErrorMessage(java.lang.String errorMessage)

Description copied from interface: I_FormWidget

Sets the error message for this widget.

If the error message is null, no error message will be displayed.

Specified by:

setErrorMessage in interface I_FormWidget

Parameters:

errorMessage - an error message or null

See Also:

I_FormWidget.setErrorMessage(java.lang.String)

setFormValue

public void setFormValue(java.lang.Object value)

Sets the form value of this select box.

Parameters:

value - the new value

setFormValueAsString

public void setFormValueAsString(java.lang.String formValue)

Description copied from interface: I_FormWidget

Sets the current value of the widget as a string.

Specified by:

setFormValueAsString in interface I_FormWidget

Parameters:

formValue - the new value of the widget

See Also:

I_FormWidget.setFormValueAsString(java.lang.String)

truncate

public void truncate(java.lang.String textMetricsPrefix,
            int widgetWidth)

Description copied from interface: I_Truncable

Truncates long text and sets the original text to the title attribute.

Specified by:

truncate in interface I_Truncable

Parameters:

textMetricsPrefix - the key identifying the text metrics to use

widgetWidth - the width to use in pixels

See Also:

I_Truncable.truncate(java.lang.String, int)

clearItems

protected void clearItems()

Internal helper method for clearing the select options.

close

protected void close()

Internal method which is called when the selector is closed.

createUnknownOption

protected abstract OPTION createUnknownOption(java.lang.String value)

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

Parameters:

value - the value for which to create the option

Returns:

the new option

doClickOpener

@UiHandler(value="m_opener")
protected void doClickOpener(com.google.gwt.event.dom.client.ClickEvent e)

Handle clicks on the opener.

Parameters:

e - the click event

initMaxCellWidth

protected void initMaxCellWidth()

Initializes the selector width.

initOpener

protected abstract void initOpener()

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

onValueSelect

protected void onValueSelect(java.lang.String value)

Internal handler method which is called when a new value is selected.

Parameters:

value - the new value

open

protected void open()

Internal method which is called when the selector is opened.

truncateOpener

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

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

Parameters:

prefix - the text metrics prefix

width - the widget width

updateOpener

protected abstract void updateOpener(java.lang.String newValue)

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

Parameters:

newValue - the value selected by the user