org.opencms.gwt.client.ui.input

类 CmsSelectBox

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

所有已实现的接口:

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

直接已知子类:

CmsPropertySelectBox

public class CmsSelectBox
extends A_CmsSelectBox<CmsLabelSelectCell>
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.

从以下版本开始:

8.0.0

嵌套类概要

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

A_CmsSelectBox.I_CmsSelectBoxUiBinder, A_CmsSelectBox.ScrollEventPreviewHandler

从类继承的嵌套类/接口 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 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.

从类继承的字段 org.opencms.gwt.client.ui.input.A_CmsSelectBox

CSS, m_error, m_eventBus, m_openClose, m_opener, m_panel, m_popup, m_previewHandlerRegistration, m_selectBoxState, m_selectCells, m_selectedValue, m_selector, m_selectorState

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

DEBUG_ID_PREFIX

构造器概要

构造器

构造器和说明
CmsSelectBox() Default constructor.
CmsSelectBox(java.util.Map<java.lang.String,java.lang.String> items) Constructs a new select box from a map.
CmsSelectBox(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.

方法概要

方法

限定符和类型	方法和说明
void	addOption(java.lang.String value, java.lang.String text) Adds a new selection cell.
protected CmsLabelSelectCell	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.
java.util.Map<java.lang.String,java.lang.String>	getItems() Returns the items as a map for option values to label text.
com.google.gwt.user.client.ui.FocusPanel	getOpener() Returns the opener of this widget.
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	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	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(CmsLabelSelectCell 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.

从类继承的方法 org.opencms.gwt.client.ui.input.A_CmsSelectBox

addFocusHandler, addOption, addValueChangeHandler, clearItems, close, doClickOpener, getFieldType, getFormValue, getFormValueAsString, getSelectorPopup, initMaxCellWidth, isEnabled, onBrowserEvent, onDetach, onFocus, onValueSelect, onValueSelect, open, removeWindowResizeHandler, reset, setEnabled, setErrorMessage, setFormValue, setFormValue, setFormValueAsString, setPopupResize, truncate

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

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

fireEvent

字段详细资料

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.

另请参阅:

常量字段值

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.

另请参阅:

常量字段值

m_ghostValue

protected java.lang.String m_ghostValue

The ghost value.

m_openerWidget

protected CmsLabel m_openerWidget

The widget displayed in the opener.

构造器详细资料

CmsSelectBox

public CmsSelectBox()

Default constructor.

CmsSelectBox

public CmsSelectBox(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.

参数:

items - the map of select options

CmsSelectBox

public CmsSelectBox(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.

参数:

items - the map of select options

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

方法详细资料

initClass

public static void initClass()

Initializes this class.

addOption

public void addOption(java.lang.String value,
             java.lang.String text)

Adds a new selection cell.

参数:

value - the value of the select option

text - the text to be displayed for the select option

getApparentValue

public java.lang.String getApparentValue()

从接口复制的说明: I_CmsFormWidget

Returns the "apparent value", i.e. either the real value if available, or else the ghost value if available, or null otherwise.

指定者:

getApparentValue 在接口中 I_CmsFormWidget

返回:

the apparent value

另请参阅:

I_CmsFormWidget.getApparentValue()

getItems

public java.util.Map<java.lang.String,java.lang.String> getItems()

Returns the items as a map for option values to label text.

返回:

the items as a map for option values to label text

getOpener

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

Returns the opener of this widget.

返回:

the opener of this widget

selectValue

public void selectValue(java.lang.String value)

从类复制的说明: A_CmsSelectBox

Helper method to set the current selected option.

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

覆盖:

selectValue 在类中 A_CmsSelectBox<CmsLabelSelectCell>

参数:

value - the new value

另请参阅:

A_CmsSelectBox.selectValue(java.lang.String)

setAutoHideParent

public void setAutoHideParent(I_CmsAutoHider autoHideParent)

从接口复制的说明: I_CmsFormWidget

Call this when auto hiding parents are shown.

指定者:

setAutoHideParent 在接口中 I_CmsFormWidget

参数:

autoHideParent - the auto hide parent

另请参阅:

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

setGhostMode

public void setGhostMode(boolean ghostMode)

从接口复制的说明: I_CmsHasGhostValue

Enables or disables ghost mode, if possible.

指定者:

setGhostMode 在接口中 I_CmsHasGhostValue

参数:

ghostMode - if ghost mode should be enabled, else disabled

另请参阅:

I_CmsHasGhostValue.setGhostMode(boolean)

setGhostValue

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

从接口复制的说明: 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.

指定者:

setGhostValue 在接口中 I_CmsHasGhostValue

参数:

value - the ghost value

ghostMode - if true, sets the widget to ghost mode

另请参阅:

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

参数:

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.

参数:

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!

参数:

option - the select option value

title - the new title for the option

truncateOpener

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

从类复制的说明: A_CmsSelectBox

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

指定者:

truncateOpener 在类中 A_CmsSelectBox<CmsLabelSelectCell>

参数:

prefix - the text metrics prefix

width - the widget width

另请参阅:

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

updateCell

public void updateCell(CmsLabelSelectCell cell)

Updates a single select cell.

参数:

cell - the select cell to update

updateCells

public void updateCells()

Updates the select cells.

createUnknownOption

protected CmsLabelSelectCell createUnknownOption(java.lang.String value)

从类复制的说明: A_CmsSelectBox

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

指定者:

createUnknownOption 在类中 A_CmsSelectBox<CmsLabelSelectCell>

参数:

value - the value for which to create the option

返回:

the new option

另请参阅:

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.

参数:

option - the select option value

defaultValue - the value to return when no title for the value was found

返回:

the title for the select option

initOpener

protected void initOpener()

从类复制的说明: A_CmsSelectBox

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

指定者:

initOpener 在类中 A_CmsSelectBox<CmsLabelSelectCell>

另请参阅:

A_CmsSelectBox.initOpener()

onLoad

protected void onLoad()

覆盖:

onLoad 在类中 A_CmsSelectBox<CmsLabelSelectCell>

另请参阅:

Widget.onLoad()

updateOpener

protected void updateOpener(java.lang.String newValue)

从类复制的说明: A_CmsSelectBox

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

指定者:

updateOpener 在类中 A_CmsSelectBox<CmsLabelSelectCell>

参数:

newValue - the value selected by the user

另请参阅:

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.