oracle.adfdt.view.dvt.binding.pattern.timeline.extension

Class TimelineExtendedProperties

java.lang.Object

oracle.adfdt.view.dvt.binding.pattern.options.ComplexExtendedProperties

oracle.adfdt.view.dvt.binding.pattern.timeline.extension.TimelineExtendedProperties

All Implemented Interfaces:

ExtendedProperties

public class TimelineExtendedProperties
extends ComplexExtendedProperties

A set of accessor methods that allow the user to change the structure and functionality of a timeline.

Field Summary

Fields inherited from class oracle.adfdt.view.dvt.binding.pattern.options.ComplexExtendedProperties

AF_NS, DVT_NS, F_NS

Constructor Summary

Constructors

Constructor and Description
TimelineExtendedProperties()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAnimationOnDataChange() Description: the animation effect when a data change event occurs.
java.lang.String	getAnimationOnDisplay() Description: the animation effect during initial display of the timeline.
java.lang.String	getBinding() Description: an EL reference that will store the component instance on a bean.
java.lang.String	getContentDelivery() Description: Options are "lazy", "immediate", and "whenAvailble".
java.util.Date	getCurrentTime(java.text.DateFormat dFormat) Description: the current time which will be marked with an indicator on the timeline.
java.util.Date	getEndTime(java.text.DateFormat dFormat) Description: the end time of the timeline.
java.util.Date	getFetchEndTime(java.text.DateFormat dFormat) Deprecated. This attribute is deprecated. It only has an affect when the deprecated 'timelineSeries' and 'timelineItem' child tags are specified.
java.util.Date	getFetchStartTime(java.text.DateFormat dFormat) Deprecated. This attribute is deprecated. It only has an affect when the deprecated 'timelineSeries' and 'timelineItem' child tags are specified.
java.lang.String	getId() Description: the identifier for the component
java.lang.String	getInlineStyle() Description: the CSS styles to use for this component.
java.lang.String	getItemPosition() Description: how items are layout vertically in the available space in the timeline.
java.lang.String	getItemSelection() Description: whether items in the timeline are selectable.
java.lang.String	getOrientation() Description: specifies the orientation of the timeline.
java.lang.String[]	getPartialTriggers() Description: the IDs of the components that should trigger a partial update.
java.lang.String	getSortData() Description: whether data from the underlying model should be sorted automatically by the timeline based on time of the event.
java.util.Date	getStartTime(java.text.DateFormat dFormat) Description: the start time of the timeline.
java.lang.String	getStyleClass() Description: a CSS style class to use for this component.
java.lang.String	getSummary() Description: the summary of this timeline's purpose and structure for user agents rendering to non-visual media (e.g.
java.lang.String	getTagName()
boolean	isRendered() Description: specifies whether the component is rendered.
java.lang.String	isRenderedAsString() Description: specifies whether the component is rendered.
boolean	isVisible() Description: the visibility of the component.
java.lang.String	isVisibleAsString() Description: the visibility of the component.
void	setAnimationOnDataChange(java.lang.String animationOnDataChange) Description: the animation effect when a data change event occurs.
void	setAnimationOnDisplay(java.lang.String animationOnDisplay) Description: the animation effect during initial display of the timeline.
void	setBinding(java.lang.String binding) Description: an EL reference that will store the component instance on a bean.
void	setContentDelivery(java.lang.String contentDelivery) Description: Options are "lazy", "immediate", and "whenAvailble".
void	setCurrentTime(java.util.Date currentTime, java.text.DateFormat dFormat) Description: the current time which will be marked with an indicator on the timeline.
void	setEndTime(java.util.Date endTime, java.text.DateFormat dFormat) Description: the end time of the timeline.
void	setFetchEndTime(java.util.Date fetchEndTime, java.text.DateFormat dFormat) Deprecated. This attribute is deprecated. It only has an affect when the deprecated 'timelineSeries' and 'timelineItem' child tags are specified.
void	setFetchStartTime(java.util.Date fetchStartTime, java.text.DateFormat dFormat) Deprecated. This attribute is deprecated. It only has an affect when the deprecated 'timelineSeries' and 'timelineItem' child tags are specified.
void	setId(java.lang.String id) Description: the identifier for the component
void	setInlineStyle(java.lang.String inlineStyle) Description: the CSS styles to use for this component.
void	setItemPosition(java.lang.String itemPosition) Description: how items are layout vertically in the available space in the timeline.
void	setItemSelection(java.lang.String itemSelection) Description: whether items in the timeline are selectable.
void	setOrientation(java.lang.String orientation) Description: specifies the orientation of the timeline.
void	setPartialTriggers(java.lang.String[] partialTriggers) Description: the IDs of the components that should trigger a partial update.
void	setRendered(boolean rendered) Description: specifies whether the component is rendered.
void	setRenderedAsString(java.lang.String rendered) Description: specifies whether the component is rendered.
void	setSortData(java.lang.String sortData) Description: whether data from the underlying model should be sorted automatically by the timeline based on time of the event.
void	setStartTime(java.util.Date startTime, java.text.DateFormat dFormat) Description: the start time of the timeline.
void	setStyleClass(java.lang.String styleClass) Description: a CSS style class to use for this component.
void	setSummary(java.lang.String summary) Description: the summary of this timeline's purpose and structure for user agents rendering to non-visual media (e.g.
void	setVisible(boolean visible) Description: the visibility of the component.
void	setVisibleAsString(java.lang.String visible) Description: the visibility of the component.

Methods inherited from class oracle.adfdt.view.dvt.binding.pattern.options.ComplexExtendedProperties

_applyToRootElement, _applyToRootElement, applyChanges, applyChanges, applyChanges, applyChanges, applyChanges, cloneFrom, getAttribute, getComplexChild, getComplexChild, getComplexChildAsList, populateAttributesAndChildTags, removeComplexChildList, setAttribute, setComplexChild, setComplexChild, setComplexChildAsList

Methods inherited from class java.lang.Object

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

Constructor Detail

TimelineExtendedProperties

public TimelineExtendedProperties()

Method Detail

getTagName

public java.lang.String getTagName()

Specified by:

getTagName in class ComplexExtendedProperties

getAnimationOnDataChange

public java.lang.String getAnimationOnDataChange()

Description: the animation effect when a data change event occurs. Valid values are: "default", "none". The default value is "default".

Returns:

the value of the animationOnDataChange attribute of the Tag this class represents.

setAnimationOnDataChange

public void setAnimationOnDataChange(java.lang.String animationOnDataChange)

Description: the animation effect when a data change event occurs. Valid values are: "default", "none". The default value is "default".

Parameters:

animationOnDataChange - the value of the animationOnDataChange attribute of the Tag this class represents.

getAnimationOnDisplay

public java.lang.String getAnimationOnDisplay()

Description: the animation effect during initial display of the timeline. Valid values are: "default", "none". The default value is "default".

Returns:

the value of the animationOnDisplay attribute of the Tag this class represents.

setAnimationOnDisplay

public void setAnimationOnDisplay(java.lang.String animationOnDisplay)

Description: the animation effect during initial display of the timeline. Valid values are: "default", "none". The default value is "default".

Parameters:

animationOnDisplay - the value of the animationOnDisplay attribute of the Tag this class represents.

getBinding

public java.lang.String getBinding()

Description: an EL reference that will store the component instance on a bean. This can be used to give programmatic access to a component from a backing bean, or to move creation of the component to a backing bean.

Returns:

the value of the binding attribute of the Tag this class represents.

setBinding

public void setBinding(java.lang.String binding)

Description: an EL reference that will store the component instance on a bean. This can be used to give programmatic access to a component from a backing bean, or to move creation of the component to a backing bean.

Parameters:

binding - the value of the binding attribute of the Tag this class represents.

getContentDelivery

public java.lang.String getContentDelivery()

Description: Options are "lazy", "immediate", and "whenAvailble". If "lazy", then the content of the timeline is fetched after the timeline is sent to the browser. If "immediate", then the content of the timeline is immediately sent to the browser. If "whenAvailable", then "immediate" content delivery is used if the data is already available; otherwise "lazy" content delivery is used. The default value is "whenAvailable".

Returns:

the value of the contentDelivery attribute of the Tag this class represents.

setContentDelivery

public void setContentDelivery(java.lang.String contentDelivery)

Description: Options are "lazy", "immediate", and "whenAvailble". If "lazy", then the content of the timeline is fetched after the timeline is sent to the browser. If "immediate", then the content of the timeline is immediately sent to the browser. If "whenAvailable", then "immediate" content delivery is used if the data is already available; otherwise "lazy" content delivery is used. The default value is "whenAvailable".

Parameters:

contentDelivery - the value of the contentDelivery attribute of the Tag this class represents.

getCurrentTime

public java.util.Date getCurrentTime(java.text.DateFormat dFormat)
                              throws java.lang.Exception

Description: the current time which will be marked with an indicator on the timeline.

Parameters:

dFormat - A DateFormat instance used to convert the Date type property.

Returns:

the value of the currentTime attribute of the Tag this class represents.

Throws:

java.lang.Exception

setCurrentTime

public void setCurrentTime(java.util.Date currentTime,
                           java.text.DateFormat dFormat)

Description: the current time which will be marked with an indicator on the timeline.

Parameters:

currentTime - the value of the currentTime attribute of the Tag this class represents.

dFormat - A DateFormat instance used to convert the Date type property.

getEndTime

public java.util.Date getEndTime(java.text.DateFormat dFormat)
                          throws java.lang.Exception

Description: the end time of the timeline.

Parameters:

dFormat - A DateFormat instance used to convert the Date type property.

Returns:

the value of the endTime attribute of the Tag this class represents.

Throws:

java.lang.Exception

setEndTime

public void setEndTime(java.util.Date endTime,
                       java.text.DateFormat dFormat)

Description: the end time of the timeline.

Parameters:

endTime - the value of the endTime attribute of the Tag this class represents.

dFormat - A DateFormat instance used to convert the Date type property.

getFetchEndTime

@Deprecated
public java.util.Date getFetchEndTime(java.text.DateFormat dFormat)
                                           throws java.lang.Exception

Deprecated. This attribute is deprecated. It only has an affect when the deprecated 'timelineSeries' and 'timelineItem' child tags are specified.

Description: the end of the time range where data is currently being fetched.

Parameters:

dFormat - A DateFormat instance used to convert the Date type property.

Returns:

the value of the fetchEndTime attribute of the Tag this class represents.

Throws:

java.lang.Exception

setFetchEndTime

@Deprecated
public void setFetchEndTime(java.util.Date fetchEndTime,
                                        java.text.DateFormat dFormat)

Deprecated. This attribute is deprecated. It only has an affect when the deprecated 'timelineSeries' and 'timelineItem' child tags are specified.

Description: the end of the time range where data is currently being fetched.

Parameters:

fetchEndTime - the value of the fetchEndTime attribute of the Tag this class represents.

dFormat - A DateFormat instance used to convert the Date type property.

getFetchStartTime

@Deprecated
public java.util.Date getFetchStartTime(java.text.DateFormat dFormat)
                                             throws java.lang.Exception

Deprecated. This attribute is deprecated. It only has an affect when the deprecated 'timelineSeries' and 'timelineItem' child tags are specified.

Description: the start of the time range where data is currently being fetched.

Parameters:

dFormat - A DateFormat instance used to convert the Date type property.

Returns:

the value of the fetchStartTime attribute of the Tag this class represents.

Throws:

java.lang.Exception

setFetchStartTime

@Deprecated
public void setFetchStartTime(java.util.Date fetchStartTime,
                                          java.text.DateFormat dFormat)

Deprecated. This attribute is deprecated. It only has an affect when the deprecated 'timelineSeries' and 'timelineItem' child tags are specified.

Description: the start of the time range where data is currently being fetched.

Parameters:

fetchStartTime - the value of the fetchStartTime attribute of the Tag this class represents.

dFormat - A DateFormat instance used to convert the Date type property.

getId

public java.lang.String getId()

Description: the identifier for the component

Returns:

the value of the id attribute of the Tag this class represents.

setId

public void setId(java.lang.String id)

Description: the identifier for the component

Parameters:

id - the value of the id attribute of the Tag this class represents.

getInlineStyle

public java.lang.String getInlineStyle()

Description: 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. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute. 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 value of the inlineStyle attribute of the Tag this class represents.

setInlineStyle

public void setInlineStyle(java.lang.String inlineStyle)

Description: 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. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute. 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 value of the inlineStyle attribute of the Tag this class represents.

getItemPosition

public java.lang.String getItemPosition()

Description: how items are layout vertically in the available space in the timeline. Use the value "noOverlap" to layout items such that none of them overlap each other. Use the value "random" to randomly layout the items vertically in the available space in the timeline. Note that "noOverlap" is not supported for vertical timeline.

Returns:

the value of the itemPosition attribute of the Tag this class represents.

setItemPosition

public void setItemPosition(java.lang.String itemPosition)

Description: how items are layout vertically in the available space in the timeline. Use the value "noOverlap" to layout items such that none of them overlap each other. Use the value "random" to randomly layout the items vertically in the available space in the timeline. Note that "noOverlap" is not supported for vertical timeline.

Parameters:

itemPosition - the value of the itemPosition attribute of the Tag this class represents.

getItemSelection

public java.lang.String getItemSelection()

Description: whether items in the timeline are selectable. Use the value "single" to enable single selection and "multiple" to enable multiple selection. Note that this applies to item across timeline series. I.e. if "single" is specified, then only one item among all timeline series are selectable at a time.

Returns:

the value of the itemSelection attribute of the Tag this class represents.

setItemSelection

public void setItemSelection(java.lang.String itemSelection)

Description: whether items in the timeline are selectable. Use the value "single" to enable single selection and "multiple" to enable multiple selection. Note that this applies to item across timeline series. I.e. if "single" is specified, then only one item among all timeline series are selectable at a time.

Parameters:

itemSelection - the value of the itemSelection attribute of the Tag this class represents.

getOrientation

public java.lang.String getOrientation()

Description: specifies the orientation of the timeline. The default value is "horizontal", in which case the time axis and the timeline items flows from left to right (or right to left in rtl mode). If the value is "vertical", then the time axis and the timeline items flows from top to bottom.

Returns:

the value of the orientation attribute of the Tag this class represents.

setOrientation

public void setOrientation(java.lang.String orientation)

Description: specifies the orientation of the timeline. The default value is "horizontal", in which case the time axis and the timeline items flows from left to right (or right to left in rtl mode). If the value is "vertical", then the time axis and the timeline items flows from top to bottom.

Parameters:

orientation - the value of the orientation attribute of the Tag this class represents.

getPartialTriggers

public java.lang.String[] getPartialTriggers()

Description: 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, 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, or multiple colons to move up through the NamingContainers - "::" will search from the parent naming container, ":::" will search from the grandparent naming container, etc.

Returns:

the value of the partialTriggers attribute of the Tag this class represents.

setPartialTriggers

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

Description: 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, 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, or multiple colons to move up through the NamingContainers - "::" will search from the parent naming container, ":::" will search from the grandparent naming container, etc.

Parameters:

partialTriggers - the value of the partialTriggers attribute of the Tag this class represents.

isRendered

public boolean isRendered()

Description: specifies whether the component is rendered. The default value is true.

Returns:

the value of the rendered attribute of the Tag this class represents.

setRendered

public void setRendered(boolean rendered)

Description: specifies whether the component is rendered. The default value is true.

Parameters:

rendered - the value of the rendered attribute of the Tag this class represents.

isRenderedAsString

public java.lang.String isRenderedAsString()

Description: specifies whether the component is rendered. The default value is true. This method is provided as a convenience to be able to retrieve an EL that was set on the rendered attribute.

Returns:

the value of the rendered attribute of the Tag this class represents.

setRenderedAsString

public void setRenderedAsString(java.lang.String rendered)

Description: specifies whether the component is rendered. The default value is true. This method is provided as a convenience to be able to set an EL on the rendered attribute.

Parameters:

rendered - the value of the rendered attribute of the Tag this class represents.

getSortData

public java.lang.String getSortData()

Description: whether data from the underlying model should be sorted automatically by the timeline based on time of the event. The timeline requires the data to be sorted based on time. This attribute allows the application to control whether sorting should be done automatically by the timeline or manually by the model itself. Valid values are: "auto", "none". The default value is "auto".

Returns:

the value of the sortData attribute of the Tag this class represents.

setSortData

public void setSortData(java.lang.String sortData)

Description: whether data from the underlying model should be sorted automatically by the timeline based on time of the event. The timeline requires the data to be sorted based on time. This attribute allows the application to control whether sorting should be done automatically by the timeline or manually by the model itself. Valid values are: "auto", "none". The default value is "auto".

Parameters:

sortData - the value of the sortData attribute of the Tag this class represents.

getStartTime

public java.util.Date getStartTime(java.text.DateFormat dFormat)
                            throws java.lang.Exception

Description: the start time of the timeline.

Parameters:

dFormat - A DateFormat instance used to convert the Date type property.

Returns:

the value of the startTime attribute of the Tag this class represents.

Throws:

java.lang.Exception

setStartTime

public void setStartTime(java.util.Date startTime,
                         java.text.DateFormat dFormat)

Description: the start time of the timeline.

Parameters:

startTime - the value of the startTime attribute of the Tag this class represents.

dFormat - A DateFormat instance used to convert the Date type property.

getStyleClass

public java.lang.String getStyleClass()

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

Returns:

the value of the styleClass attribute of the Tag this class represents.

setStyleClass

public void setStyleClass(java.lang.String styleClass)

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

Parameters:

styleClass - the value of the styleClass attribute of the Tag this class represents.

getSummary

public java.lang.String getSummary()

Description: the summary of this timeline's purpose and structure for user agents rendering to non-visual media (e.g. screen readers).

Returns:

the value of the summary attribute of the Tag this class represents.

setSummary

public void setSummary(java.lang.String summary)

Description: the summary of this timeline's purpose and structure for user agents rendering to non-visual media (e.g. screen readers).

Parameters:

summary - the value of the summary attribute of the Tag this class represents.

isVisible

public boolean isVisible()

Description: 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. The default value is true.

Returns:

the value of the visible attribute of the Tag this class represents.

setVisible

public void setVisible(boolean visible)

Description: 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. The default value is true.

Parameters:

visible - the value of the visible attribute of the Tag this class represents.

isVisibleAsString

public java.lang.String isVisibleAsString()

Description: 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. The default value is true. This method is provided as a convenience to be able to retrieve an EL that was set on the visible attribute.

Returns:

the value of the visible attribute of the Tag this class represents.

setVisibleAsString

public void setVisibleAsString(java.lang.String visible)

Description: 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. The default value is true. This method is provided as a convenience to be able to set an EL on the visible attribute.

Parameters:

visible - the value of the visible attribute of the Tag this class represents.