org.opencms.gwt.client.ui.input

类 A_CmsSelectBox<OPTION extends A_CmsSelectCell>

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

类型参数:

OPTION - the widget type of the select options

所有已实现的接口:

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_CmsTruncable, I_CmsFormWidget

直接已知子类:

CmsComboBox, CmsMultiSelectBox, CmsSelectBox

public abstract class A_CmsSelectBox<OPTION extends A_CmsSelectCell>
extends com.google.gwt.user.client.ui.Composite
implements I_CmsFormWidget, com.google.gwt.event.logical.shared.HasValueChangeHandlers<java.lang.String>, com.google.gwt.event.dom.client.HasFocusHandlers, I_CmsTruncable

Abstract superclass for select box widgets.

从以下版本开始:

8.0.0

嵌套类概要

嵌套类

限定符和类型	类和说明
protected static interface	A_CmsSelectBox.I_CmsSelectBoxUiBinder The UI Binder interface for this widget.
protected class	A_CmsSelectBox.ScrollEventPreviewHandler Drag and drop event preview handler.

从类继承的嵌套类/接口 com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

从接口继承的嵌套类/接口 org.opencms.gwt.client.ui.input.I_CmsFormWidget

I_CmsFormWidget.FieldType

字段概要

字段

限定符和类型	字段和说明
protected static I_CmsInputCss	CSS The layout bundle.
protected CmsErrorWidget	m_error Error widget.
protected com.google.gwt.event.shared.SimpleEventBus	m_eventBus The event bus.
protected CmsPushButton	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 com.google.gwt.event.shared.HandlerRegistration	m_previewHandlerRegistration The preview handler registration.
protected CmsStyleVariable	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 CmsStyleVariable	m_selectorState Style of the select box widget.

从类继承的字段 com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

构造器概要

构造器

构造器和说明
A_CmsSelectBox() Creates a new select box.

方法概要

方法

限定符和类型	方法和说明
com.google.gwt.event.shared.HandlerRegistration	addFocusHandler(com.google.gwt.event.dom.client.FocusHandler handler)
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_CmsFormWidget.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.
com.google.gwt.user.client.ui.Panel	getSelectorPopup() Returns the selector of this widget.
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	onDetach()
protected void	onFocus(com.google.gwt.event.dom.client.FocusEvent event) Handles the focus event on the opener.
protected void	onLoad()
protected void	onValueSelect(java.lang.String value) This method is called when a value is selected.
protected void	onValueSelect(java.lang.String value, boolean fireEvents) 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.
protected void	removeWindowResizeHandler() Deinstalls the window resize handler.
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	setFormValue(java.lang.Object value, boolean fireEvents) 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	setPopupResize(boolean resize) Sets the behavior of the popup if the input is bigger than the selectbox itself.
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.

从类继承的方法 com.google.gwt.user.client.ui.Composite

claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onAttach, render, render, resolvePotentialElement, setWidget

从类继承的方法 com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onUnload, removeFromParent, setLayoutData, sinkEvents

从类继承的方法 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

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.opencms.gwt.client.ui.input.I_CmsFormWidget

getApparentValue, setAutoHideParent

从接口继承的方法 com.google.gwt.event.shared.HasHandlers

fireEvent

字段详细资料

CSS

protected static final I_CmsInputCss CSS

The layout bundle.

m_error

@UiField
protected CmsErrorWidget m_error

Error widget.

m_eventBus

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

The event bus.

m_openClose

protected CmsPushButton 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_previewHandlerRegistration

protected com.google.gwt.event.shared.HandlerRegistration m_previewHandlerRegistration

The preview handler registration.

m_selectBoxState

protected final CmsStyleVariable m_selectBoxState

Style of the select box widget.

m_selectCells

protected java.util.Map<java.lang.String,OPTION extends A_CmsSelectCell> 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 CmsStyleVariable m_selectorState

Style of the select box widget.

构造器详细资料

A_CmsSelectBox

public A_CmsSelectBox()

Creates a new select box.

方法详细资料

addFocusHandler

public com.google.gwt.event.shared.HandlerRegistration addFocusHandler(com.google.gwt.event.dom.client.FocusHandler handler)

指定者:

addFocusHandler 在接口中 com.google.gwt.event.dom.client.HasFocusHandlers

另请参阅:

HasFocusHandlers.addFocusHandler(com.google.gwt.event.dom.client.FocusHandler)

addOption

public void addOption(OPTION cell)

Adds a new select option to the select box.

参数:

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)

指定者:

addValueChangeHandler 在接口中 com.google.gwt.event.logical.shared.HasValueChangeHandlers<java.lang.String>

另请参阅:

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

getFieldType

public I_CmsFormWidget.FieldType getFieldType()

从接口复制的说明: I_CmsFormWidget

Returns the type of data this widget produces.

指定者:

getFieldType 在接口中 I_CmsFormWidget

返回:

the data type

另请参阅:

I_CmsFormWidget.getFieldType()

getFormValue

public java.lang.Object getFormValue()

从接口复制的说明: I_CmsFormWidget

Gets the selected/entered value from the widget.

指定者:

getFormValue 在接口中 I_CmsFormWidget

返回:

the value

另请参阅:

I_CmsFormWidget.getFormValue()

getFormValueAsString

public java.lang.String getFormValueAsString()

从接口复制的说明: I_CmsFormWidget

Gets the current value of the widget as a string.

指定者:

getFormValueAsString 在接口中 I_CmsFormWidget

返回:

the current value of the widget

另请参阅:

I_CmsFormWidget.getFormValueAsString()

getSelectorPopup

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

Returns the selector of this widget.

返回:

the selector of this widget

isEnabled

public boolean isEnabled()

从接口复制的说明: I_CmsFormWidget

Returns true if this widget is enabled.

指定者:

isEnabled 在接口中 I_CmsFormWidget

返回:

true if this widget is enabled

另请参阅:

I_CmsFormWidget.isEnabled()

onBrowserEvent

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

指定者:

onBrowserEvent 在接口中 com.google.gwt.user.client.EventListener

覆盖:

onBrowserEvent 在类中 com.google.gwt.user.client.ui.Composite

另请参阅:

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

reset

public void reset()

从接口复制的说明: I_CmsFormWidget

Resets the widget to its default state.

指定者:

reset 在接口中 I_CmsFormWidget

另请参阅:

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

参数:

value - the new value

setEnabled

public void setEnabled(boolean enabled)

从接口复制的说明: I_CmsFormWidget

Enables or disables the widget.

指定者:

setEnabled 在接口中 I_CmsFormWidget

参数:

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

另请参阅:

I_CmsFormWidget.setEnabled(boolean)

setErrorMessage

public void setErrorMessage(java.lang.String errorMessage)

从接口复制的说明: I_CmsFormWidget

Sets the error message for this widget.

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

指定者:

setErrorMessage 在接口中 I_CmsFormWidget

参数:

errorMessage - an error message or null

另请参阅:

I_CmsFormWidget.setErrorMessage(java.lang.String)

setFormValue

public void setFormValue(java.lang.Object value)

Sets the form value of this select box.

参数:

value - the new value

setFormValue

public void setFormValue(java.lang.Object value,
                boolean fireEvents)

Sets the form value of this select box.

参数:

value - the new value

fireEvents - true if change events should be fired

setFormValueAsString

public void setFormValueAsString(java.lang.String formValue)

从接口复制的说明: I_CmsFormWidget

Sets the current value of the widget as a string.

指定者:

setFormValueAsString 在接口中 I_CmsFormWidget

参数:

formValue - the new value of the widget

另请参阅:

I_CmsFormWidget.setFormValueAsString(java.lang.String)

setPopupResize

public void setPopupResize(boolean resize)

Sets the behavior of the popup if the input is bigger than the selectbox itself.

参数:

resize -

truncate

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

从接口复制的说明: I_CmsTruncable

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

指定者:

truncate 在接口中 I_CmsTruncable

参数:

textMetricsPrefix - the key identifying the text metrics to use

widgetWidth - the width to use in pixels

另请参阅:

I_CmsTruncable.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.

参数:

value - the value for which to create the option

返回:

the new option

doClickOpener

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

Handle clicks on the opener.

参数:

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.

onDetach

protected void onDetach()

覆盖:

onDetach 在类中 com.google.gwt.user.client.ui.Composite

另请参阅:

Composite.onDetach()

onFocus

@UiHandler(value="m_opener")
protected void onFocus(com.google.gwt.event.dom.client.FocusEvent event)

Handles the focus event on the opener.

参数:

event -

onLoad

protected void onLoad()

覆盖:

onLoad 在类中 com.google.gwt.user.client.ui.Widget

另请参阅:

Widget.onLoad()

onValueSelect

protected void onValueSelect(java.lang.String value)

This method is called when a value is selected.

参数:

value - the selected value

onValueSelect

protected void onValueSelect(java.lang.String value,
                 boolean fireEvents)

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

参数:

value - the new value

fireEvents - true if change events should be fired

open

protected void open()

Internal method which is called when the selector is opened.

removeWindowResizeHandler

protected void removeWindowResizeHandler()

Deinstalls the window resize handler.

truncateOpener

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

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

参数:

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.

参数:

newValue - the value selected by the user