org.zkoss.zul.api
Interface Datebox

All Superinterfaces:
java.lang.Cloneable, Component, Constrainted, FormatInputElement, HtmlBasedComponent, InputElement, Scope, java.io.Serializable, XulElement
All Known Implementing Classes:
Datebox

public interface Datebox
extends FormatInputElement

An edit box for holding a date.

The default format (FormatInputElement.getFormat()) depends on JVM's setting and the current user's locale. That is, DateFormat.getDateInstance(DateFormat,DEFAULT, Locales.getCurrent). You might override Datebox.getDefaultFormat() to provide your own default format.

Default HtmlBasedComponent.getZclass(): z-datebox.(since 3.5.0)

Since:
3.5.2
Author:
tomyeh

Field Summary
 
Fields inherited from interface org.zkoss.zk.ui.Component
APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE
 
Method Summary
 void close()
          Closes the calendar if it was dropped down.
 java.util.TimeZone getTimeZone()
          Returns the time zone that this date box belongs to, or null if the default time zone is used.
 java.util.Date getValue()
          Returns the value (in Date), might be null unless a constraint stops it.
 boolean isButtonVisible()
          Returns whether the button (on the right of the textbox) is visible.
 boolean isCompact()
          Deprecated. As of release 5.0.0, it is no longer supported.
 boolean isLenient()
          Returns whether or not date/time parsing is to be lenient.
 void open()
          Drops down the calendar to select a date.
 void setButtonVisible(boolean visible)
          Sets whether the button (on the right of the textbox) is visible.
 void setCompact(boolean compact)
          Deprecated. As of release 5.0.0, it is no longer supported.
 void setLenient(boolean lenient)
          Returns whether or not date/time parsing is to be lenient.
 void setOpen(boolean open)
          Drops down or closes the calendar to select a date.
 void setTimeZone(java.util.TimeZone tzone)
          Sets the time zone that this date box belongs to, or null if the default time zone is used.
 void setValue(java.util.Date value)
          Sets the value (in Date).
 
Methods inherited from interface org.zkoss.zul.impl.api.FormatInputElement
getFormat, setFormat
 
Methods inherited from interface org.zkoss.zul.impl.api.InputElement
clearErrorMessage, clearErrorMessage, getCols, getErrorMessage, getMaxlength, getName, getRawText, getRawValue, getTabindex, getText, getType, isDisabled, isMultiline, isReadonly, isValid, select, setCols, setConstraint, setDisabled, setMaxlength, setName, setRawValue, setReadonly, setSelectedText, setSelectionRange, setTabindex, setText
 
Methods inherited from interface org.zkoss.zul.impl.api.XulElement
getAction, getContext, getCtrlKeys, getPopup, getTooltip, setAction, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip
 
Methods inherited from interface org.zkoss.zk.ui.api.HtmlBasedComponent
focus, getHeight, getLeft, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZclass, getZindex, getZIndex, setDraggable, setDroppable, setFocus, setHeight, setLeft, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex
 
Methods inherited from interface org.zkoss.zk.ui.Component
addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, containsVariable, detach, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getDefinition, getDesktop, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, setWidgetListener, setWidgetOverride, unsetVariable
 
Methods inherited from interface org.zkoss.zk.ui.ext.Scope
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute
 
Methods inherited from interface org.zkoss.zul.ext.Constrainted
getConstraint, setConstraint
 

Method Detail

isLenient

boolean isLenient()
Returns whether or not date/time parsing is to be lenient.

With lenient parsing, the parser may use heuristics to interpret inputs that do not precisely match this object's format. With strict parsing, inputs must match this object's format.


setLenient

void setLenient(boolean lenient)
Returns whether or not date/time parsing is to be lenient.

Default: true.

With lenient parsing, the parser may use heuristics to interpret inputs that do not precisely match this object's format. With strict parsing, inputs must match this object's format.


isCompact

boolean isCompact()
Deprecated. As of release 5.0.0, it is no longer supported.


setCompact

void setCompact(boolean compact)
Deprecated. As of release 5.0.0, it is no longer supported.


isButtonVisible

boolean isButtonVisible()
Returns whether the button (on the right of the textbox) is visible.

Default: true.


setButtonVisible

void setButtonVisible(boolean visible)
Sets whether the button (on the right of the textbox) is visible.


getValue

java.util.Date getValue()
                        throws WrongValueException
Returns the value (in Date), might be null unless a constraint stops it.

Throws:
WrongValueException - if user entered a wrong value

setValue

void setValue(java.util.Date value)
              throws WrongValueException
Sets the value (in Date).

Throws:
WrongValueException - if value is wrong

getTimeZone

java.util.TimeZone getTimeZone()
Returns the time zone that this date box belongs to, or null if the default time zone is used.

The default time zone is determined by TimeZones.getCurrent().


setTimeZone

void setTimeZone(java.util.TimeZone tzone)
Sets the time zone that this date box belongs to, or null if the default time zone is used.

The default time zone is determined by TimeZones.getCurrent().


setOpen

void setOpen(boolean open)
Drops down or closes the calendar to select a date.

See Also:
open(), close()

open

void open()
Drops down the calendar to select a date. The same as setOpen(true).


close

void close()
Closes the calendar if it was dropped down. The same as setOpen(false).



Copyright © 2005-2009 Potix Corporation. All Rights Reserved. SourceForge.net Logo