com.ibm.xsp.component.xp
Class XspDateTimeHelper

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by com.ibm.xsp.component.UIDateTimeHelper
              extended by com.ibm.xsp.component.xp.XspDateTimeHelper
All Implemented Interfaces:
FacesDojoComponent, FacesDojoComponentDelegate, ThemeControl, javax.faces.component.StateHolder

public class XspDateTimeHelper
extends UIDateTimeHelper

A DateTimeHelper for the edit box. Uses dojo.

XPages Core Controls - Date Time Picker

Represents an instance of the Dojo Date Time Picker


Nested Class Summary
 
Nested classes/interfaces inherited from class javax.faces.component.UIComponentBase
javax.faces.component.UIComponentBase.AggregatedIterator, javax.faces.component.UIComponentBase.UnmodifiableIterator
 
Nested classes/interfaces inherited from class javax.faces.component.UIComponent
javax.faces.component.UIComponent.StateMap, javax.faces.component.UIComponent.StateMapEntry
 
Field Summary
static java.lang.String COMPONENT_TYPE
           
static java.lang.String RENDERER_TYPE
           
 
Fields inherited from class com.ibm.xsp.component.UIDateTimeHelper
COMPONENT_FAMILY, PARENT_RENDERER_TYPE
 
Fields inherited from class javax.faces.component.UIComponentBase
EMPTY_ITERATOR
 
Fields inherited from class javax.faces.component.UIComponent
_xspStateId
 
Constructor Summary
XspDateTimeHelper()
           
 
Method Summary
 java.lang.String getDojoUsage()
           Return the value of the dojoUsage property.
 java.lang.String getTimeClickableIncrement()
           Return the value of the timeClickableIncrement property.
 java.lang.String getTimeVisibleIncrement()
           Return the value of the timeVisibleIncrement property.
 java.lang.String getTimeVisibleRange()
           Return the value of the timeVisibleRange property.
 void restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext _context)
           
 void setDojoUsage(java.lang.String dojoUsage)
           Set the value of the dojoUsage property.
 void setTimeClickableIncrement(java.lang.String timeClickableIncrement)
           Set the value of the timeClickableIncrement property.
 void setTimeVisibleIncrement(java.lang.String timeVisibleIncrement)
           Set the value of the timeVisibleIncrement property.
 void setTimeVisibleRange(java.lang.String timeVisibleRange)
           Set the value of the timeVisibleRange property.
 
Methods inherited from class com.ibm.xsp.component.UIDateTimeHelper
addDojoAttribute, getDojoAttributes, getDojoComponent, getDojoType, getFamily, getParentRendererType, getStyleKitFamily, isChangeParentRenderer, setDojoAttributes, setDojoType, setParent
 
Methods inherited from class javax.faces.component.UIComponentBase
_xspCleanTransientData, _xspGetReadOnlyObj, _xspGetRendererData, _xspRemoveReadOnlyObj, _xspRemoveRendererData, _xspSetIdUnchecked, _xspSetReadOnlyObj, _xspSetRendererData, addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
_xspGetStateId, _xspGetStateMap, _xspRestoreAttribute, _xspRestoreState, _xspSaveState, invokeOnComponent, isVisitable, markInitialState, setControlState, visitTree
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE
See Also:
Constant Field Values
Constructor Detail

XspDateTimeHelper

public XspDateTimeHelper()
Method Detail

getDojoUsage

public java.lang.String getDojoUsage()

Return the value of the dojoUsage property. Contents:

This property is obsolete, configure the "Dojo Type" property instead. This used to determine whether the control would use Dojo.

XPages Basics Property Category - Dojo Usage


getTimeClickableIncrement

public java.lang.String getTimeClickableIncrement()

Return the value of the timeClickableIncrement property. Contents:

This property only applies to a DateTimeHelper which is selecting time. ISO-8601 string representing the amount by which every clickable element in the time picker increases. Set in non-Zulu time, without a time zone. Example: "T00:15:00" creates 15 minute increments. Must divide visibleIncrement evenly.


getTimeVisibleIncrement

public java.lang.String getTimeVisibleIncrement()

Return the value of the timeVisibleIncrement property. Contents:

This property only applies to a DateTimeHelper which is selecting time. ISO-8601 string representing the amount by which every element with a visible time in the time picker increases. Set in non-Zulu time, without a time zone or date. Example: "T01:00:00" creates text in every one hour increment.


getTimeVisibleRange

public java.lang.String getTimeVisibleRange()

Return the value of the timeVisibleRange property. Contents:

This property only applies to a DateTimeHelper which is selecting time. ISO-8601 string representing the range of this time picker. The time picker will only display times in this range. Example: "T05:00:00" displays 5 hours of options.


restoreState

public void restoreState(javax.faces.context.FacesContext _context,
                         java.lang.Object _state)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class UIDateTimeHelper

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext _context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class UIDateTimeHelper

setDojoUsage

public void setDojoUsage(java.lang.String dojoUsage)

Set the value of the dojoUsage property.


setTimeClickableIncrement

public void setTimeClickableIncrement(java.lang.String timeClickableIncrement)

Set the value of the timeClickableIncrement property.


setTimeVisibleIncrement

public void setTimeVisibleIncrement(java.lang.String timeVisibleIncrement)

Set the value of the timeVisibleIncrement property.


setTimeVisibleRange

public void setTimeVisibleRange(java.lang.String timeVisibleRange)

Set the value of the timeVisibleRange property.