org.opencms.gwt.client.ui.input

类 CmsTextBox

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

所有已实现的接口:

com.google.gwt.event.dom.client.HasBlurHandlers, com.google.gwt.event.dom.client.HasClickHandlers, com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.event.dom.client.HasKeyPressHandlers, 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_CmsFormWidget, I_CmsHasBlur, I_CmsHasGhostValue

public class CmsTextBox
extends com.google.gwt.user.client.ui.Composite
implements I_CmsFormWidget, I_CmsHasInit, com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.event.dom.client.HasBlurHandlers, com.google.gwt.event.logical.shared.HasValueChangeHandlers<java.lang.String>, com.google.gwt.event.dom.client.HasKeyPressHandlers, com.google.gwt.event.dom.client.HasClickHandlers, I_CmsHasBlur, I_CmsHasGhostValue

Basic text box class for forms.

从以下版本开始:

8.0.0

嵌套类概要

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

字段概要

字段

限定符和类型	字段和说明
static I_CmsInputCss	CSS The CSS bundle used for this widget.
protected boolean	m_ghostMode Flag for ghost mode.
protected java.lang.String	m_ghostValue The ghost value.
protected com.google.gwt.user.client.ui.TextBox	m_textbox The text box used internally by this widget.
protected static int[]	NAVIGATION_CODES Key codes for functional keys.
static java.lang.String	WIDGET_TYPE The widget type identifier for this widget.

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

DEBUG_ID_PREFIX

构造器概要

构造器

构造器和说明
CmsTextBox() Constructs a new instance of this widget.

方法概要

方法

限定符和类型	方法和说明
com.google.gwt.event.shared.HandlerRegistration	addBlurHandler(com.google.gwt.event.dom.client.BlurHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addClickHandler(com.google.gwt.event.dom.client.ClickHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addFocusHandler(com.google.gwt.event.dom.client.FocusHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addKeyPressHandler(com.google.gwt.event.dom.client.KeyPressHandler handler)
com.google.gwt.event.shared.HandlerRegistration	addValueChangeHandler(com.google.gwt.event.logical.shared.ValueChangeHandler<java.lang.String> handler)
void	blur() Makes the widget lose focus.
protected void	fireValueChangedEvent() Fires a value change event.
protected void	fireValueChangedEvent(boolean inhibitValidation) Helper method for firing a 'value changed' event.
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.
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.
java.lang.String	getId() Returns the HTML id of the internal textbox used by this widget.
java.lang.String	getText() Returns the text in the text box.
com.google.gwt.user.client.ui.TextBox	getTextBox() Returns the Textbox of this widget.
CmsPaddedPanel	getTextBoxContainer() Returns the Panel of this widget.
boolean	hasError() Returns true if this textbox has an error set.
protected void	hideError() Hides the error for this textbox.
static void	initClass() Initializes this class.
boolean	isEnabled() Gets whether this widget is enabled.
protected boolean	isNavigationKey(int keyCode) Checks if the given key code represents a functional key.
boolean	isPreventShowError() Returns the preventShowError.
boolean	isReadOnly() Returns the read only flag.
boolean	isTriggerChangeOnKeyPress() Returns if the text box is set to trigger the value changed event on key press and not on blur only.
void	onBrowserEvent(com.google.gwt.user.client.Event event)
void	reset() Resets the widget to its default state.
void	setAutoHideParent(I_CmsAutoHider autoHideParent) Call this when auto hiding parents are shown.
void	setChangedStyle() Sets the changed style on the text box.
void	setEnabled(boolean enabled) Enables or disables the widget.
void	setErrorMessage(java.lang.String errorMessage) Sets the error message for this widget.
void	setErrorMessageWidth(java.lang.String width) Sets the width of the error message for this textbox.
void	setFocus(boolean focused) Sets the focus on the text box.
void	setFormValueAsString(java.lang.String newValue) Sets the current value of the widget as a string.
void	setGhostMode(boolean ghostMode) Enables or disables ghost mode.
void	setGhostModeClear(boolean clearOnChangeMode) Sets if the input field should be cleared when leaving the ghost mode.
void	setGhostStyleEnabled(boolean enabled, boolean mayClear) Enables or disables the "ghost mode" style.
void	setGhostValue(java.lang.String value, boolean ghostMode) Sets the "ghost value" of the widget and optionally sets it to "ghost mode".
void	setInhibitValidationForKeypresses(boolean inhibitValidationForKeypresses) Sets the 'inhibitValidationForKeypresses' flag.
void	setName(java.lang.String name) Sets the name of the input box.
void	setPreventShowError(boolean preventShowError) Sets the preventShowError.
void	setReadOnly(boolean readOnly) Enables or disables read-only mode.
void	setTriggerChangeOnKeyPress(boolean triggerOnKeyPress) Sets if the value changed event should be triggered on key press and not on blur only.
void	setValueInTextBoxDelayed(java.lang.String value) Sets the value of the text box after a short delay.
protected void	showError() Shows the error for this textbox.
void	updateLayout() Updates the layout of the text box.

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

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

字段详细资料

CSS

public static final I_CmsInputCss CSS

The CSS bundle used for this widget.

WIDGET_TYPE

public static final java.lang.String WIDGET_TYPE

The widget type identifier for this widget.

另请参阅:

常量字段值

NAVIGATION_CODES

protected static final int[] NAVIGATION_CODES

Key codes for functional keys.

m_ghostMode

protected boolean m_ghostMode

Flag for ghost mode.

m_ghostValue

protected java.lang.String m_ghostValue

The ghost value.

m_textbox

protected com.google.gwt.user.client.ui.TextBox m_textbox

The text box used internally by this widget.

构造器详细资料

CmsTextBox

public CmsTextBox()

Constructs a new instance of this widget.

方法详细资料

initClass

public static void initClass()

Initializes this class.

addBlurHandler

public com.google.gwt.event.shared.HandlerRegistration addBlurHandler(com.google.gwt.event.dom.client.BlurHandler handler)

指定者:

addBlurHandler 在接口中 com.google.gwt.event.dom.client.HasBlurHandlers

另请参阅:

HasBlurHandlers.addBlurHandler(com.google.gwt.event.dom.client.BlurHandler)

addClickHandler

public com.google.gwt.event.shared.HandlerRegistration addClickHandler(com.google.gwt.event.dom.client.ClickHandler handler)

指定者:

addClickHandler 在接口中 com.google.gwt.event.dom.client.HasClickHandlers

另请参阅:

HasClickHandlers.addClickHandler(com.google.gwt.event.dom.client.ClickHandler)

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)

addKeyPressHandler

public com.google.gwt.event.shared.HandlerRegistration addKeyPressHandler(com.google.gwt.event.dom.client.KeyPressHandler handler)

指定者:

addKeyPressHandler 在接口中 com.google.gwt.event.dom.client.HasKeyPressHandlers

另请参阅:

HasKeyPressHandlers.addKeyPressHandler(com.google.gwt.event.dom.client.KeyPressHandler)

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)

blur

public void blur()

从接口复制的说明: I_CmsHasBlur

Makes the widget lose focus.

指定者:

blur 在接口中 I_CmsHasBlur

另请参阅:

I_CmsHasBlur.blur()

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()

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()

getId

public java.lang.String getId()

Returns the HTML id of the internal textbox used by this widget.

返回:

the HTML id of the internal textbox used by this widget

getText

public java.lang.String getText()

Returns the text in the text box.

返回:

the text

getTextBox

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

Returns the Textbox of this widget.

返回:

the CmsTextBox

getTextBoxContainer

public CmsPaddedPanel getTextBoxContainer()

Returns the Panel of this widget.

返回:

the Panel

hasError

public boolean hasError()

Returns true if this textbox has an error set.

返回:

true if this textbox has an error set

isEnabled

public boolean isEnabled()

Gets whether this widget is enabled.

指定者:

isEnabled 在接口中 I_CmsFormWidget

返回:

true if the widget is enabled

isPreventShowError

public boolean isPreventShowError()

Returns the preventShowError.

返回:

the preventShowError

isReadOnly

public boolean isReadOnly()

Returns the read only flag.

返回:

true if this text box is only readable

isTriggerChangeOnKeyPress

public boolean isTriggerChangeOnKeyPress()

Returns if the text box is set to trigger the value changed event on key press and not on blur only.

返回:

true if the text box is set to trigger the value changed event on key press

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()

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)

setChangedStyle

public void setChangedStyle()

Sets the changed style on the text box.

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)

setErrorMessageWidth

public void setErrorMessageWidth(java.lang.String width)

Sets the width of the error message for this textbox.

参数:

width - the object's new width, in CSS units (e.g. "10px", "1em")

setFocus

public void setFocus(boolean focused)

Sets the focus on the text box.

参数:

focused - signals if the focus should be set

setFormValueAsString

public void setFormValueAsString(java.lang.String newValue)

从接口复制的说明: I_CmsFormWidget

Sets the current value of the widget as a string.

指定者:

setFormValueAsString 在接口中 I_CmsFormWidget

参数:

newValue - the new value of the widget

另请参阅:

I_CmsFormWidget.setFormValueAsString(java.lang.String)

setGhostMode

public void setGhostMode(boolean ghostMode)

Enables or disables ghost mode.

指定者:

setGhostMode 在接口中 I_CmsHasGhostValue

参数:

ghostMode - if true, enables ghost mode, else disables it

setGhostModeClear

public void setGhostModeClear(boolean clearOnChangeMode)

Sets if the input field should be cleared when leaving the ghost mode.

参数:

clearOnChangeMode - true to clear on leaving the ghost mode

setGhostStyleEnabled

public void setGhostStyleEnabled(boolean enabled,
                        boolean mayClear)

Enables or disables the "ghost mode" style.

This *only* changes the style, not the actual mode.

参数:

enabled - true if the ghost mode style should be enabled, false if it should be disabled

mayClear - true if no value was previously set

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)

setInhibitValidationForKeypresses

public void setInhibitValidationForKeypresses(boolean inhibitValidationForKeypresses)

Sets the 'inhibitValidationForKeypresses' flag.

参数:

inhibitValidationForKeypresses - the new flag value

setName

public void setName(java.lang.String name)

Sets the name of the input box.

参数:

name - of the input box

setPreventShowError

public void setPreventShowError(boolean preventShowError)

Sets the preventShowError.

参数:

preventShowError - the preventShowError to set

setReadOnly

public void setReadOnly(boolean readOnly)

Enables or disables read-only mode.

参数:

readOnly - if true, enables read-only mode, else disables it

setTriggerChangeOnKeyPress

public void setTriggerChangeOnKeyPress(boolean triggerOnKeyPress)

Sets if the value changed event should be triggered on key press and not on blur only.

参数:

triggerOnKeyPress - true if the value changed event should be triggered on key press

setValueInTextBoxDelayed

public void setValueInTextBoxDelayed(java.lang.String value)

Sets the value of the text box after a short delay.

参数:

value - the value to set

updateLayout

public void updateLayout()

Updates the layout of the text box.

fireValueChangedEvent

protected void fireValueChangedEvent()

Fires a value change event.

fireValueChangedEvent

protected void fireValueChangedEvent(boolean inhibitValidation)

Helper method for firing a 'value changed' event.

参数:

inhibitValidation - if true, some additional information will be added to the event to ask event handlers to not perform any validation directly

hideError

protected void hideError()

Hides the error for this textbox.

isNavigationKey

protected boolean isNavigationKey(int keyCode)

Checks if the given key code represents a functional key.

参数:

keyCode - the key code to check

返回:

true if the given key code represents a functional key

showError

protected void showError()

Shows the error for this textbox.