UITimelineItem (Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components)

java.lang.Object
- javax.faces.component.UIComponent
- - org.apache.myfaces.trinidad.component.UIXComponent
  - - org.apache.myfaces.trinidad.component.UIXComponentBase
    - - oracle.adf.view.faces.bi.component.timeline.UITimelineItem

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder
```
public class UITimelineItem
extends org.apache.myfaces.trinidad.component.UIXComponentBase
implements javax.faces.component.behavior.ClientBehaviorHolder
```
The timelinelItem component must be placed inside of a timeline series component. It represents an event in the timeline. The following components are allowed as a children of timelineItem: af:outputTxt af:image

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
  org.apache.myfaces.trinidad.component.UIXComponentBase.ComponentSystemEventListenerWrapper

Field Summary

Fields
Modifier and Type	Field and Description
`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`	`END_TIME_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`GROUP_KEY`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`INLINE_STYLE_KEY`
`static java.lang.String`	`OVERVIEW_ITEM_FACET`
`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`	`VALUE_KEY`
`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
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors
Constructor and Description

UITimelineItem()

UITimelineItem(java.lang.String string)

Constructors
Constructor and Description
`UITimelineItem()`
`UITimelineItem(java.lang.String string)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior)`
`protected org.apache.myfaces.trinidad.bean.FacesBean.Type`	`getBeanType()`
`java.util.Set`	`getClientAttributes()` Gets a set of client attribute names.
`java.util.Map<java.lang.String,java.util.List<javax.faces.component.behavior.ClientBehavior>>`	`getClientBehaviors()`
`oracle.adf.view.rich.event.ClientListenerSet`	`getClientListeners()` Gets a set of client listeners.
`java.lang.String`	`getDefaultEventName()`
`java.util.Date`	`getEndTime()` Gets the end time of the timeline item.
`java.util.Collection<java.lang.String>`	`getEventNames()`
`java.lang.String`	`getFamily()`
`java.lang.String`	`getGroup()` Gets the group for this timeline item.
`java.lang.String`	`getInlineStyle()` Gets the CSS styles to use for this component.
`java.lang.String[]`	`getPartialTriggers()` Gets the IDs of the components that should trigger a partial update.
`java.util.Iterator<javax.faces.component.UIComponent>`	`getRenderedFacetsAndChildren(javax.faces.context.FacesContext context)`
`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.
`java.util.Date`	`getValue()` Gets the time of the timeline item.
`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(oracle.adf.view.rich.event.ClientListenerSet clientListeners)` Sets a set of client listeners.
`void`	`setEndTime(java.util.Date endTime)` Sets the end time of the timeline item.
`void`	`setGroup(java.lang.String group)` Sets the group for this timeline item.
`void`	`setInlineStyle(java.lang.String inlineStyle)` Sets the CSS styles to use for this component.
`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`	`setValue(java.util.Date time)` Sets the time of the timeline item.
`void`	`setVisible(boolean visible)` Sets the visibility of the component.

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getPassThroughAttributes, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setupFlattenedChildrenContext, setupFlattenedContext, setValueBinding, setValueExpression, subscribeToEvent, tearDownFlattenedChildrenContext, tearDownFlattenedContext, toString, unsubscribeFromEvent, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent
addPartialTarget, broadcastInContext, clearCachedClientIds, defaultGetRenderedFacetsAndChildren, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - 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
  - TYPE
```
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
```
  - CLIENT_ATTRIBUTES_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY
```
  - CLIENT_COMPONENT_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY
```
  - CLIENT_LISTENERS_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY
```
  - END_TIME_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey END_TIME_KEY
```
  - GROUP_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey GROUP_KEY
```
  - INLINE_STYLE_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
```
  - PARTIAL_TRIGGERS_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
```
  - SHORT_DESC_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
```
  - STYLE_CLASS_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
```
  - VALUE_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey VALUE_KEY
```
  - VISIBLE_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY
```
  - OVERVIEW_ITEM_FACET
```
public static final java.lang.String OVERVIEW_ITEM_FACET
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - UITimelineItem
```
public UITimelineItem(java.lang.String string)
```
  - UITimelineItem
```
public UITimelineItem()
```
- Method Detail
  - getFamily
```
public java.lang.String getFamily()
```
    Specified by:
    
    getFamily in class org.apache.myfaces.trinidad.component.UIXComponentBase
  - getBeanType
```
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
```
    Overrides:
    
    getBeanType in class org.apache.myfaces.trinidad.component.UIXComponentBase
  - getEndTime
```
public final java.util.Date getEndTime()
```
    Gets the end time of the timeline item.
    
    Returns:
    
    the end time of the timeline item.
  - setEndTime
```
public final void setEndTime(java.util.Date endTime)
```
    Sets the end time of the timeline item.
    
    Parameters:
    
    endTime - the end time of the timeline item.
  - getGroup
```
public final java.lang.String getGroup()
```
    Gets the group for this timeline item. All timeline items within the same group are displayed together in a timeline. Typically all items within the group have the same value.
    
    Returns:
    
    the group for this timeline item.
  - setGroup
```
public final void setGroup(java.lang.String group)
```
    Sets the group for this timeline item. All timeline items within the same group are displayed together in a timeline. Typically all items within the group have the same value.
    
    Parameters:
    
    group - the group for this timeline item.
  - 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. 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 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. 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 new inlineStyle 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
  - 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 oracle.adf.view.rich.event.ClientListenerSet getClientListeners()
```
    Gets a set of client listeners.
    
    Returns:
    
    the new clientListeners value
  - setClientListeners
```
public final void setClientListeners(oracle.adf.view.rich.event.ClientListenerSet clientListeners)
```
    Sets a set of client listeners.
    
    Parameters:
    
    clientListeners - the new clientListeners 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. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.
    
    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. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.
    
    Parameters:
    
    shortDesc - the new shortDesc value
  - getValue
```
public final java.util.Date getValue()
```
    Gets the time of the timeline item.
    
    Returns:
    
    the time of the timeline item.
  - setValue
```
public final void setValue(java.util.Date time)
```
    Sets the time of the timeline item.
    
    Parameters:
    
    time - the time of the timeline item.
  - 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
  - getRenderedFacetsAndChildren
```
public java.util.Iterator<javax.faces.component.UIComponent> getRenderedFacetsAndChildren(javax.faces.context.FacesContext context)
```
    Overrides:
    
    getRenderedFacetsAndChildren in class org.apache.myfaces.trinidad.component.UIXComponentBase
  - getDefaultEventName
```
public java.lang.String getDefaultEventName()
```
    Specified by:
    
    getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder
    
    Overrides:
    
    getDefaultEventName in class org.apache.myfaces.trinidad.component.UIXComponentBase
  - getEventNames
```
public java.util.Collection<java.lang.String> getEventNames()
```
    Specified by:
    
    getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder
  - getClientBehaviors
```
public java.util.Map<java.lang.String,java.util.List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
```
    Specified by:
    
    getClientBehaviors in interface javax.faces.component.behavior.ClientBehaviorHolder
    
    Overrides:
    
    getClientBehaviors in class org.apache.myfaces.trinidad.component.UIXComponentBase
  - addClientBehavior
```
public void addClientBehavior(java.lang.String eventName,
                              javax.faces.component.behavior.ClientBehavior behavior)
```
    Specified by:
    
    addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolder
    
    Overrides:
    
    addClientBehavior in class org.apache.myfaces.trinidad.component.UIXComponentBase

Class UITimelineItem

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

Field Summary

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

Fields inherited from class javax.faces.component.UIComponent

Constructor Summary

Method Summary

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

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

Methods inherited from class javax.faces.component.UIComponent

Methods inherited from class java.lang.Object

Field Detail

COMPONENT_FAMILY

COMPONENT_TYPE

TYPE

CLIENT_ATTRIBUTES_KEY

CLIENT_COMPONENT_KEY

CLIENT_LISTENERS_KEY

END_TIME_KEY

GROUP_KEY

INLINE_STYLE_KEY

PARTIAL_TRIGGERS_KEY

SHORT_DESC_KEY

STYLE_CLASS_KEY

VALUE_KEY

VISIBLE_KEY

OVERVIEW_ITEM_FACET

Constructor Detail

UITimelineItem

UITimelineItem

Method Detail

getFamily

getBeanType

getEndTime

setEndTime

getGroup

setGroup

getInlineStyle

setInlineStyle

getPartialTriggers

setPartialTriggers

isClientComponent

setClientComponent

getClientAttributes

setClientAttributes

getClientListeners

setClientListeners

getStyleClass

setStyleClass

getShortDesc

setShortDesc

getValue

setValue

isVisible

setVisible

getRenderedFacetsAndChildren

getDefaultEventName

getEventNames

getClientBehaviors

addClientBehavior