oracle.adf.view.rich.component.rich.input
Class RichChooseDate

java.lang.Object
  javax.faces.component.UIComponent
      org.apache.myfaces.trinidad.component.UIXComponent
          org.apache.myfaces.trinidad.component.UIXComponentBase
              org.apache.myfaces.trinidad.component.UIXChoose
                  oracle.adf.view.rich.component.rich.input.RichChooseDate

All Implemented Interfaces:

javax.faces.component.StateHolder

public class RichChooseDate
extends org.apache.myfaces.trinidad.component.UIXChoose

The chooseDate component is used in conjunction with a inputDate to allow the user to quickly select a date value without having to navigate to a secondary window. The chooseDate is typically used for tasks where selecting a date value is a critical part of the task flow. Instead of requiring the user to select the date from a secondary window, a chooseDate can be displayed inline in the page contents. Users can then select a date directly within the chooseDate, which will cause the currently focused inputDate to be updated with the selected date. In order to indicate that a particular inputDate should be updated in response to chooseDate selection changes, the the inputDate's "chooseId" attribute must be set to the id of the associated chooseDate component.

Events:

Type	Phases	Description
org.apache.myfaces.trinidad.event.AttributeChangeEvent	Invoke Application Apply Request Values	Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.

Field Summary

static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_ATTRIBUTES_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_COMPONENT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_LISTENERS_KEY
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	CUSTOMIZATION_ID_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DISABLED_DAYS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DISABLED_DAYS_OF_WEEK_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DISABLED_MONTHS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MAX_VALUE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MIN_VALUE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_TRIGGERS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHORT_DESC_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	STYLE_CLASS_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	VISIBLE_KEY

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Fields inherited from class javax.faces.component.UIComponent

bindings

Constructor Summary

	RichChooseDate() Construct an instance of the RichChooseDate.
protected	RichChooseDate(java.lang.String rendererType) Construct an instance of the RichChooseDate.

Method Summary

protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.util.Set	getClientAttributes() Gets a set of client attribute names.
ClientListenerSet	getClientListeners() Gets a set of client listeners.
java.lang.String	getCustomizationId() Gets This attribute is deprecated.
org.apache.myfaces.trinidad.model.DateListProvider	getDisabledDays() Gets a binding to an implementation of the org.apache.myfaces.trinidad.model.DateListProvider interface.
java.util.Set	getDisabledDaysOfWeek() Gets a whitespace delimited list of weekdays that should be rendered as disabled in every week.
java.util.Set	getDisabledMonths() Gets a whitespace delimited list of months that should be rendered as disabled in every year.
java.lang.String	getFamily()
java.lang.String	getInlineStyle() Gets the CSS styles to use for this component.
java.util.Date	getMaxValue() Gets the maximum value allowed for the Date value.
java.util.Date	getMinValue() Gets the minimum value allowed for the Date value.
java.lang.String[]	getPartialTriggers() Gets the IDs of the components that should trigger a partial update.
java.lang.String	getShortDesc() Gets the short description of the component.
java.lang.String	getStyleClass() Gets a CSS style class to use for this component.
boolean	isClientComponent() Gets whether a client-side component will be generated.
boolean	isVisible() Gets the visibility of the component.
void	setClientAttributes(java.util.Set clientAttributes) Sets a set of client attribute names.
void	setClientComponent(boolean clientComponent) Sets whether a client-side component will be generated.
void	setClientListeners(ClientListenerSet clientListeners) Sets a set of client listeners.
void	setCustomizationId(java.lang.String customizationId) Sets This attribute is deprecated.
void	setDisabledDays(org.apache.myfaces.trinidad.model.DateListProvider disabledDays) Sets a binding to an implementation of the org.apache.myfaces.trinidad.model.DateListProvider interface.
void	setDisabledDaysOfWeek(java.util.Set disabledDaysOfWeek) Sets a whitespace delimited list of weekdays that should be rendered as disabled in every week.
void	setDisabledMonths(java.util.Set disabledMonths) Sets a whitespace delimited list of months that should be rendered as disabled in every year.
void	setInlineStyle(java.lang.String inlineStyle) Sets the CSS styles to use for this component.
void	setMaxValue(java.util.Date maxValue) Sets the maximum value allowed for the Date value.
void	setMinValue(java.util.Date minValue) Sets the minimum value allowed for the Date value.
void	setPartialTriggers(java.lang.String[] partialTriggers) Sets the IDs of the components that should trigger a partial update.
void	setShortDesc(java.lang.String shortDesc) Sets the short description of the component.
void	setStyleClass(java.lang.String styleClass) Sets a CSS style class to use for this component.
void	setVisible(boolean visible) Sets the visibility of the component.

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeFacesListener, restoreState, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent

processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren

Methods inherited from class javax.faces.component.UIComponent

getContainerClientId, invokeOnComponent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

INLINE_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY

STYLE_CLASS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY

SHORT_DESC_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY

VISIBLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY

CUSTOMIZATION_ID_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY

CLIENT_COMPONENT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY

CLIENT_ATTRIBUTES_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY

CLIENT_LISTENERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY

PARTIAL_TRIGGERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY

MAX_VALUE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey MAX_VALUE_KEY

MIN_VALUE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey MIN_VALUE_KEY

DISABLED_DAYS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DISABLED_DAYS_KEY

DISABLED_DAYS_OF_WEEK_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DISABLED_DAYS_OF_WEEK_KEY

DISABLED_MONTHS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DISABLED_MONTHS_KEY

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

See Also:

Constant Field Values

Constructor Detail

RichChooseDate

public RichChooseDate()

Construct an instance of the RichChooseDate.

RichChooseDate

protected RichChooseDate(java.lang.String rendererType)

Construct an instance of the RichChooseDate.

Method Detail

getInlineStyle

public final java.lang.String getInlineStyle()

Gets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.

Returns:

the new inlineStyle value

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)

Sets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.

Parameters:

inlineStyle - the new inlineStyle value

getStyleClass

public final java.lang.String getStyleClass()

Gets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.

Returns:

the new styleClass value

setStyleClass

public final void setStyleClass(java.lang.String styleClass)

Sets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.

Parameters:

styleClass - the new styleClass value

getShortDesc

public final java.lang.String getShortDesc()

Gets the short description of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window.

Returns:

the new shortDesc value

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)

Sets the short description of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window.

Parameters:

shortDesc - the new shortDesc value

isVisible

public final boolean isVisible()

Gets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.

Returns:

the new visible value

setVisible

public final void setVisible(boolean visible)

Sets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.

Parameters:

visible - the new visible value

getCustomizationId

public final java.lang.String getCustomizationId()

Gets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Returns:

the new customizationId value

setCustomizationId

public final void setCustomizationId(java.lang.String customizationId)

Sets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Parameters:

customizationId - the new customizationId value

isClientComponent

public final boolean isClientComponent()

Gets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.

Returns:

the new clientComponent value

setClientComponent

public final void setClientComponent(boolean clientComponent)

Sets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.

Parameters:

clientComponent - the new clientComponent value

getClientAttributes

public final java.util.Set getClientAttributes()

Gets a set of client attribute names.

Returns:

the new clientAttributes value

setClientAttributes

public final void setClientAttributes(java.util.Set clientAttributes)

Sets a set of client attribute names.

Parameters:

clientAttributes - the new clientAttributes value

getClientListeners

public final ClientListenerSet getClientListeners()

Gets a set of client listeners.

Returns:

the new clientListeners value

setClientListeners

public final void setClientListeners(ClientListenerSet clientListeners)

Sets a set of client listeners.

Parameters:

clientListeners - the new clientListeners value

getPartialTriggers

public final java.lang.String[] getPartialTriggers()

Gets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.

Returns:

the new partialTriggers value

setPartialTriggers

public final void setPartialTriggers(java.lang.String[] partialTriggers)

Sets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.

Parameters:

partialTriggers - the new partialTriggers value

getMaxValue

public final java.util.Date getMaxValue()

Gets the maximum value allowed for the Date value. When set to a fixed value on a tag, this will be parsed as an ISO 8601 date. ISO 8601 dates are of the form "yyyy-MM-dd" (for example: 2002-02-15) and the created Date object will be in the application's timezone, with the time components (hours, minutes, seconds, milliseconds) maximized. All other uses require java.util.Date objects.When binding to Date objects, it is advised to create the Date object with maximum value for any date-time components that aren't displayed (usually hours, minutes, seconds, milliseconds) to allow the largest range of values to be accepted.

Returns:

the new maxValue value

setMaxValue

public final void setMaxValue(java.util.Date maxValue)

Sets the maximum value allowed for the Date value. When set to a fixed value on a tag, this will be parsed as an ISO 8601 date. ISO 8601 dates are of the form "yyyy-MM-dd" (for example: 2002-02-15) and the created Date object will be in the application's timezone, with the time components (hours, minutes, seconds, milliseconds) maximized. All other uses require java.util.Date objects.When binding to Date objects, it is advised to create the Date object with maximum value for any date-time components that aren't displayed (usually hours, minutes, seconds, milliseconds) to allow the largest range of values to be accepted.

Parameters:

maxValue - the new maxValue value

getMinValue

public final java.util.Date getMinValue()

Gets the minimum value allowed for the Date value. When set to a fixed value on a tag, this will be parsed as an ISO 8601 date. ISO 8601 dates are of the form "yyyy-MM-dd" (for example: 2002-02-15) and the created Date object will be in the application's timezone, with the time components (hous, minutes, seconds, milliseconds) zeroed-out. All other uses require java.util.Date objects.When binding to Date objects, it is advised to create the Date object with zeroed-out values for any date-time components that aren't displayed (usually hours, minutes, seconds, milliseconds) to allow the largest range of values to be accepted.

Returns:

the new minValue value

setMinValue

public final void setMinValue(java.util.Date minValue)

Sets the minimum value allowed for the Date value. When set to a fixed value on a tag, this will be parsed as an ISO 8601 date. ISO 8601 dates are of the form "yyyy-MM-dd" (for example: 2002-02-15) and the created Date object will be in the application's timezone, with the time components (hous, minutes, seconds, milliseconds) zeroed-out. All other uses require java.util.Date objects.When binding to Date objects, it is advised to create the Date object with zeroed-out values for any date-time components that aren't displayed (usually hours, minutes, seconds, milliseconds) to allow the largest range of values to be accepted.

Parameters:

minValue - the new minValue value

getDisabledDays

public final org.apache.myfaces.trinidad.model.DateListProvider getDisabledDays()

Gets a binding to an implementation of the org.apache.myfaces.trinidad.model.DateListProvider interface. The getDateList method should generate a List of individual java.util.Date objects which will be rendered as disabled. The Dates must be in the context of the given base Calendar. Note: this binding requires periodic roundtrips. If you just want to disable certain weekdays (e.g. Saturday and Sunday), use the disabledDaysOfWeek attribute!

Returns:

the new disabledDays value

setDisabledDays

public final void setDisabledDays(org.apache.myfaces.trinidad.model.DateListProvider disabledDays)

Sets a binding to an implementation of the org.apache.myfaces.trinidad.model.DateListProvider interface. The getDateList method should generate a List of individual java.util.Date objects which will be rendered as disabled. The Dates must be in the context of the given base Calendar. Note: this binding requires periodic roundtrips. If you just want to disable certain weekdays (e.g. Saturday and Sunday), use the disabledDaysOfWeek attribute!

Parameters:

disabledDays - the new disabledDays value

getDisabledDaysOfWeek

public final java.util.Set getDisabledDaysOfWeek()

Gets a whitespace delimited list of weekdays that should be rendered as disabled in every week. The list should consist of one or more of the following abbreviations: sun, mon, tue, wed, thu, fri, sat. By default all days are enabled.

Returns:

the new disabledDaysOfWeek value

setDisabledDaysOfWeek

public final void setDisabledDaysOfWeek(java.util.Set disabledDaysOfWeek)

Sets a whitespace delimited list of weekdays that should be rendered as disabled in every week. The list should consist of one or more of the following abbreviations: sun, mon, tue, wed, thu, fri, sat. By default all days are enabled.

Parameters:

disabledDaysOfWeek - the new disabledDaysOfWeek value

getDisabledMonths

public final java.util.Set getDisabledMonths()

Gets a whitespace delimited list of months that should be rendered as disabled in every year. The list should consist of one or more of the following abbreviations: jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec. By default all months are enabled.

Returns:

the new disabledMonths value

setDisabledMonths

public final void setDisabledMonths(java.util.Set disabledMonths)

Sets a whitespace delimited list of months that should be rendered as disabled in every year. The list should consist of one or more of the following abbreviations: jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec. By default all months are enabled.

Parameters:

disabledMonths - the new disabledMonths value

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class org.apache.myfaces.trinidad.component.UIXChoose

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()

Overrides:

getBeanType in class org.apache.myfaces.trinidad.component.UIXChoose