com.ibm.xsp.component
Class UIDateTimeHelper

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          com.ibm.xsp.component.UIDateTimeHelper

All Implemented Interfaces:

FacesDojoComponent, FacesDojoComponentDelegate, ThemeControl, javax.faces.component.StateHolder

Direct Known Subclasses:

XspDateTimeHelper

public class UIDateTimeHelper
extends javax.faces.component.UIComponentBase
implements ThemeControl, FacesDojoComponentDelegate

Abstract Date time picker component that handles creating the internal components required to render the date time picker. A custom converter can be applied to this control to customise the date/time that appears, if omitted the default DateTimeConverter is used. By default, the rendererType property must be set to "javax.faces.Text" This value can be changed by calling the setRendererType() method. Not intended to be subclassed.

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_FAMILY
static java.lang.String	COMPONENT_TYPE The standard component type for this component.
static java.lang.String	PARENT_RENDERER_TYPE

Fields inherited from class javax.faces.component.UIComponentBase

EMPTY_ITERATOR

Fields inherited from class javax.faces.component.UIComponent

_xspStateId

Constructor Summary

UIDateTimeHelper()

Method Summary

void	addDojoAttribute(DojoAttribute attribute) Add a dojo attribute to the set associated with this property.
java.util.List<DojoAttribute>	getDojoAttributes() Return the value of the dojoAttributes property.
javax.faces.component.UIComponent	getDojoComponent()
java.lang.String	getDojoType() Return the value of the dojoType property.
java.lang.String	getFamily()
java.lang.String	getParentRendererType()
java.lang.String	getStyleKitFamily() The styleKitFamily is basically the default themeId, to use if the "themeId" property is not set on this control instance in the XPage source.
protected boolean	isChangeParentRenderer() Available to override in subclasses, used to determine whether to change the parent control's renderer-type.
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setDojoAttributes(java.util.List<DojoAttribute> dojoAttributes) Set the value of the dojoAttributes property.
void	setDojoType(java.lang.String dojoType) Set the value of the dojoType property.
void	setParent(javax.faces.component.UIComponent parent)

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

PARENT_RENDERER_TYPE

public static final java.lang.String PARENT_RENDERER_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

The standard component type for this component.

See Also:

Constant Field Values

Constructor Detail

UIDateTimeHelper

public UIDateTimeHelper()

Method Detail

setParent

public void setParent(javax.faces.component.UIComponent parent)

Overrides:

setParent in class javax.faces.component.UIComponentBase

getDojoComponent

public javax.faces.component.UIComponent getDojoComponent()

Specified by:

getDojoComponent in interface FacesDojoComponentDelegate

isChangeParentRenderer

protected boolean isChangeParentRenderer()

Available to override in subclasses, used to determine whether to change the parent control's renderer-type.

getStyleKitFamily

public java.lang.String getStyleKitFamily()

Description copied from interface: ThemeControl

The styleKitFamily is basically the default themeId, to use if the "themeId" property is not set on this control instance in the XPage source. For example, "InputField.EditBox" is used for most Edit Box controls. See Domino/xsp/nsf/themes/webstandard.theme for more examples.

The implementation may return different values depending on the configuration of the current control, for example the Button control returns a different value and looks different when it is configured as a cancel button.

Specified by:

getStyleKitFamily in interface ThemeControl

Returns:

a non-null themeId corresponding to the configuration for this type of control in a theme file.

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

getParentRendererType

public java.lang.String getParentRendererType()

Returns:

the parentRendererType

getDojoType

public java.lang.String getDojoType()

Return the value of the dojoType property. Contents:

Sets the default Dojo Type used to create this control in the browser.

Specified by:

getDojoType in interface FacesDojoComponent

setDojoType

public void setDojoType(java.lang.String dojoType)

Set the value of the dojoType property.

getDojoAttributes

public java.util.List<DojoAttribute> getDojoAttributes()

Return the value of the dojoAttributes property. Contents:

A list of Dojo attributes

Specified by:

getDojoAttributes in interface FacesDojoComponent

addDojoAttribute

public void addDojoAttribute(DojoAttribute attribute)

Add a dojo attribute to the set associated with this property.

Parameters:

action -

setDojoAttributes

public void setDojoAttributes(java.util.List<DojoAttribute> dojoAttributes)

Set the value of the dojoAttributes property.

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIComponentBase

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 javax.faces.component.UIComponentBase