org.opencms.gwt.client.ui.input.datebox

类 CmsDateBox

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.datebox.CmsDateBox

所有已实现的接口:

com.google.gwt.event.dom.client.HasKeyPressHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasValueChangeHandlers<java.util.Date>, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.TakesValue<java.util.Date>, com.google.gwt.user.client.ui.HasValue<java.util.Date>, 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

public class CmsDateBox
extends com.google.gwt.user.client.ui.Composite
implements com.google.gwt.user.client.ui.HasValue<java.util.Date>, I_CmsFormWidget, I_CmsHasInit, com.google.gwt.event.dom.client.HasKeyPressHandlers

A text box that shows a date time picker widget when the user clicks on it.

嵌套类概要

嵌套类

限定符和类型	类和说明
protected class	CmsDateBox.CloseEventPreviewHandler Drag and drop event preview handler.
protected class	CmsDateBox.CmsDateBoxHandler This inner class implements the handler for the date box widget.

从类继承的嵌套类/接口 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 CmsRadioButton	m_am The am radio button.
protected CmsRadioButtonGroup	m_ampmGroup The radio button group for am/pm selection.
protected I_CmsAutoHider	m_autoHideParent The auto hide parent.
protected CmsTextBox	m_box The input field to show the result of picking a date.
protected com.google.gwt.user.client.ui.FlowPanel	m_dateTimePanel The panel for the date time picker.
protected com.google.gwt.user.datepicker.client.DatePicker	m_picker The gwt date picker.
protected CmsRadioButton	m_pm The pm radio button.
protected com.google.gwt.event.shared.HandlerRegistration	m_previewHandlerRegistration Event preview handler registration.
protected CmsTextBox	m_time The text box to input the time.
protected com.google.gwt.user.client.ui.FlowPanel	m_timeField The panel for the time selection.
static java.lang.String	WIDGET_TYPE The widget type identifier for this widget.

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

DEBUG_ID_PREFIX

构造器概要

构造器

构造器和说明
CmsDateBox() Create a new date box widget with the date time picker.

方法概要

方法

限定符和类型	方法和说明
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.util.Date> handler)
protected void	executeTimeAction() Updates the updates the close behavior and sets the value of the date box to the value from the picker.
protected void	fireChange(java.util.Date newValue) Fires the value change event if needed.
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() Returns the value of the date box as String in form of a long.
CmsTextBox	getTextField() Returns the text box of this widget.
java.util.Date	getValue()
java.lang.String	getValueAsFormatedString() Returns the date value as formated String or an empty String if the date value is null.
boolean	hasErrors() Returns true if the box and the time input fields don't have any errors.
protected void	hidePopup() Hides the date time popup.
static void	initClass() Initializes this class.
boolean	isEnabled() Returns true if this widget is enabled.
boolean	isValideDateBox() Checks if the String in the date box input field is a valid date format.
protected void	onAmPmClick() If the am or pm radio button is clicked update the date box from the date time picker.
protected void	onDateBoxBlur() The date box on blur action.
protected void	onDateBoxClick() The date box on click action.
protected void	onDateBoxKeyPress(com.google.gwt.event.dom.client.KeyPressEvent event) The date box on key down action.
protected void	onFocusTimeBox() Adds the preview handler.
protected void	onPickerValueChanged() If the value of the picker changes, the value of the date time picker should be updated.
protected void	onTimeBlur() If the time field loses the focus the entered time should be checked.
void	onTimeClick() Updates the date box when the user has clicked on the time field.
protected void	onTimeKeyPressed(com.google.gwt.event.dom.client.KeyPressEvent event) If the user presses enter in the time field the value of the picker should be updated and the the popup should be closed.
protected void	previewNativeEvent(com.google.gwt.user.client.Event.NativePreviewEvent event) Blurs the time box if the user clicks outside of it.
void	reset() Resets the widget to its default state.
void	setAutoHideParent(I_CmsAutoHider autoHideParent) Call this when auto hiding parents are shown.
void	setDateOnly(boolean dateOnly) Sets the value if the date only should be shown.
void	setEnabled(boolean enabled) Enables or disables the widget.
void	setErrorMessage(java.lang.String errorMessage) Sets the error message for this widget.
void	setFormValueAsString(java.lang.String value) Expects the value as String in form of a long.
void	setInitialDate(java.util.Date initialDate) Sets the initial date shown, when the date picker is opened and no date was set before.
void	setName(java.lang.String name) Sets the name of the input field.
void	setValue(java.util.Date value)
void	setValue(java.util.Date value, boolean fireEvents)
protected void	updateCloseBehavior() Updates the auto hide partner from the parent widget.

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

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

字段详细资料

WIDGET_TYPE

public static final java.lang.String WIDGET_TYPE

The widget type identifier for this widget.

另请参阅:

常量字段值

m_am

@UiField
protected CmsRadioButton m_am

The am radio button.

m_ampmGroup

protected CmsRadioButtonGroup m_ampmGroup

The radio button group for am/pm selection.

m_autoHideParent

protected I_CmsAutoHider m_autoHideParent

The auto hide parent.

m_box

@UiField
protected CmsTextBox m_box

The input field to show the result of picking a date.

m_dateTimePanel

@UiField
protected com.google.gwt.user.client.ui.FlowPanel m_dateTimePanel

The panel for the date time picker.

m_picker

@UiField
protected com.google.gwt.user.datepicker.client.DatePicker m_picker

The gwt date picker.

m_pm

@UiField
protected CmsRadioButton m_pm

The pm radio button.

m_previewHandlerRegistration

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

Event preview handler registration.

m_time

@UiField
protected CmsTextBox m_time

The text box to input the time.

m_timeField

@UiField
protected com.google.gwt.user.client.ui.FlowPanel m_timeField

The panel for the time selection.

构造器详细资料

CmsDateBox

public CmsDateBox()

Create a new date box widget with the date time picker.

方法详细资料

initClass

public static void initClass()

Initializes this class.

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.util.Date> handler)

指定者:

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

另请参阅:

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

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

Returns the value of the date box as String in form of a long.

指定者:

getFormValueAsString 在接口中 I_CmsFormWidget

返回:

the current value of the widget

另请参阅:

I_CmsFormWidget.getFormValueAsString()

getTextField

public CmsTextBox getTextField()

Returns the text box of this widget.

返回:

the CmsText Box

getValue

public java.util.Date getValue()

指定者:

getValue 在接口中 com.google.gwt.user.client.TakesValue<java.util.Date>

指定者:

getValue 在接口中 com.google.gwt.user.client.ui.HasValue<java.util.Date>

另请参阅:

HasValue.getValue()

getValueAsFormatedString

public java.lang.String getValueAsFormatedString()

Returns the date value as formated String or an empty String if the date value is null.

返回:

the date value as formated String

hasErrors

public boolean hasErrors()

Returns true if the box and the time input fields don't have any errors.

返回:

true if the box and the time input fields don't have any errors

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

isValideDateBox

public boolean isValideDateBox()

Checks if the String in the date box input field is a valid date format.

返回:

true if the String in the date box input field is a valid date format

onTimeClick

public void onTimeClick()

Updates the date box when the user has clicked on the time field.

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)

setDateOnly

public void setDateOnly(boolean dateOnly)

Sets the value if the date only should be shown.

参数:

dateOnly - if the date only should be shown

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)

setFormValueAsString

public void setFormValueAsString(java.lang.String value)

Expects the value as String in form of a long.

指定者:

setFormValueAsString 在接口中 I_CmsFormWidget

参数:

value - the new value of the widget

另请参阅:

I_CmsFormWidget.setFormValueAsString(java.lang.String)

setInitialDate

public void setInitialDate(java.util.Date initialDate)

Sets the initial date shown, when the date picker is opened and no date was set before.

参数:

initialDate - the initial date

setName

public void setName(java.lang.String name)

Sets the name of the input field.

参数:

name - of the input field

setValue

public void setValue(java.util.Date value)

指定者:

setValue 在接口中 com.google.gwt.user.client.TakesValue<java.util.Date>

指定者:

setValue 在接口中 com.google.gwt.user.client.ui.HasValue<java.util.Date>

另请参阅:

HasValue.setValue(java.lang.Object)

setValue

public void setValue(java.util.Date value,
            boolean fireEvents)

指定者:

setValue 在接口中 com.google.gwt.user.client.ui.HasValue<java.util.Date>

另请参阅:

HasValue.setValue(java.lang.Object, boolean)

executeTimeAction

protected void executeTimeAction()

Updates the updates the close behavior and sets the value of the date box to the value from the picker.

fireChange

protected void fireChange(java.util.Date newValue)

Fires the value change event if needed.

参数:

newValue - the new value

hidePopup

protected void hidePopup()

Hides the date time popup.

onAmPmClick

protected void onAmPmClick()

If the am or pm radio button is clicked update the date box from the date time picker.

onDateBoxBlur

protected void onDateBoxBlur()

The date box on blur action.

If the date box loses the focus the date time picker should be updated from the date box value.

onDateBoxClick

protected void onDateBoxClick()

The date box on click action.

If the date box is clicked the time date picker should be shown.

onDateBoxKeyPress

protected void onDateBoxKeyPress(com.google.gwt.event.dom.client.KeyPressEvent event)

The date box on key down action.

• If enter or tab is pressed in the date box the date time picker should be updated with the value from the date box.
• If the escape key is pressed the picker should be hided.
• If the up key is pressed the value should be taken from the date box.
• If the down key is pressed the picker should be hided.

参数:

event - the key down event

onFocusTimeBox

protected void onFocusTimeBox()

Adds the preview handler.

onPickerValueChanged

protected void onPickerValueChanged()

If the value of the picker changes, the value of the date time picker should be updated.

onTimeBlur

protected void onTimeBlur()

If the time field loses the focus the entered time should be checked.

onTimeKeyPressed

protected void onTimeKeyPressed(com.google.gwt.event.dom.client.KeyPressEvent event)

If the user presses enter in the time field the value of the picker should be updated and the the popup should be closed.

In any other case the popup should be prevented to being closed.

参数:

event - the key pressed event

previewNativeEvent

protected void previewNativeEvent(com.google.gwt.user.client.Event.NativePreviewEvent event)

Blurs the time box if the user clicks outside of it.

参数:

event - the native preview event

updateCloseBehavior

protected void updateCloseBehavior()

Updates the auto hide partner from the parent widget.

If there is any invalid user input the parent widget should not be closed automatically.