oracle.adf.view.faces.bi.component.timeline
Class UITimelineSeries

java.lang.Object
  javax.faces.component.UIComponent
      org.apache.myfaces.trinidad.component.UIXComponent
          org.apache.myfaces.trinidad.component.UIXComponentBase
              org.apache.myfaces.trinidad.component.UIXCollection
                  org.apache.myfaces.trinidad.component.UIXIterator
                      oracle.adf.view.faces.bi.component.timeline.UITimelineSeries

All Implemented Interfaces:

javax.faces.component.NamingContainer, javax.faces.component.StateHolder, oracle.adf.view.rich.dnd.DragSourceFactory, org.apache.myfaces.trinidad.component.CollectionComponent, org.apache.myfaces.trinidad.component.FlattenedComponent, org.apache.myfaces.trinidad.model.LocalRowKeyIndex, org.apache.myfaces.trinidad.model.RowKeyIndex

public class UITimelineSeries
extends org.apache.myfaces.trinidad.component.UIXIterator
implements org.apache.myfaces.trinidad.component.CollectionComponent, oracle.adf.view.rich.dnd.DragSourceFactory

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.myfaces.trinidad.model.LocalRowKeyIndex

org.apache.myfaces.trinidad.model.LocalRowKeyIndex.Confidence, org.apache.myfaces.trinidad.model.LocalRowKeyIndex.LocalCachingStrategy

Field Summary

static org.apache.myfaces.trinidad.bean.PropertyKey	BLOCK_END_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	BLOCK_START_KEY
static java.lang.String	BODY_CONTEXT_MENU_FACET
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 java.lang.String	CONTENT_DELIVERY_IMMEDIATE
static org.apache.myfaces.trinidad.bean.PropertyKey	CONTENT_DELIVERY_KEY
static java.lang.String	CONTENT_DELIVERY_LAZY
static java.lang.String	CONTENT_DELIVERY_WHENAVAILABLE
static java.lang.String	CONTEXT_MENU_FACET
static org.apache.myfaces.trinidad.bean.PropertyKey	EMPTY_TEXT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_TRIGGERS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SELECTED_ROW_KEYS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SELECTION_LISTENER_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.UIXIterator

FIRST_KEY, ROWS_KEY, VALUE_KEY, VAR_STATUS_KEY

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

VAR_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

Fields inherited from interface oracle.adf.view.rich.dnd.DragSourceFactory

DEFAULT_DRAGSOURCE

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

UITimelineSeries()

UITimelineSeries(java.lang.String string)

Method Summary

void	addSelectionListener(org.apache.myfaces.trinidad.event.SelectionListener listener) Adds a selection listener.
void	broadcast(javax.faces.event.FacesEvent evt) Internal.
oracle.adf.view.rich.dnd.DragSource	createDragSource(java.lang.String name, java.util.Set<oracle.adf.view.rich.dnd.DnDAction> allowedActions, oracle.adf.view.rich.dnd.DnDAction defaultAction, java.lang.String discriminant, javax.el.MethodExpression dragDropEndListener, java.util.Map<java.lang.String,?> properties)
java.lang.CharSequence	createDragSourceBehavior(java.lang.String name, oracle.adf.view.rich.dnd.DragSource dragSource, java.util.Set<oracle.adf.view.rich.dnd.DnDAction> allowedActions, oracle.adf.view.rich.dnd.DnDAction defaultAction, java.lang.String discriminant, javax.el.MethodExpression dragDropEndListener, java.util.Map<java.lang.String,?> properties)
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.util.Set	getClientAttributes() Gets a set of client attribute names.
oracle.adf.view.rich.event.ClientListenerSet	getClientListeners() Gets a set of client listeners.
java.lang.String	getContentDelivery() Gets whether data should be fetched when the component is rendered initially.
java.lang.String	getEmptyText() Gets the text of an empty timeline.
java.lang.String	getFamily()
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.
org.apache.myfaces.trinidad.model.RowKeySet	getSelectedRowKeys()
javax.el.MethodExpression	getSelectionListener() Gets a method reference to a selection listener
org.apache.myfaces.trinidad.event.SelectionListener[]	getSelectionListeners() Returns an array of attached selection listeners.
java.lang.String	getShortDesc()
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.
protected void	postCreateCollectionModel(org.apache.myfaces.trinidad.model.CollectionModel model)
void	removeSelectionListener(org.apache.myfaces.trinidad.event.SelectionListener listener) Removes a selection listener.
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	setContentDelivery(java.lang.String contentDelivery) Sets whether data should be fetched when the component is rendered initially.
void	setEmptyText(java.lang.String emptyText) Sets the text of an empty timeline.
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	setSelectedRowKeys(org.apache.myfaces.trinidad.model.RowKeySet rowKeySet)
void	setSelectionListener(javax.el.MethodExpression selectionListener) Sets a method reference to a selection listener
void	setShortDesc(java.lang.String shortDesc)
void	setStyleClass(java.lang.String styleClass) Sets a CSS style class to use for this component.

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

createCollectionModel, createVarStatusMap, encodeChildren, getFirst, getRendersChildren, getRows, getValue, getVarStatus, isFlatteningChildren, processFacetsAndChildren, processFlattenedChildren, setFirst, setRows, setValue, setVarStatus, visitTree

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

areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearCurrencyStringCache, clearLocalCache, decodeChildrenImpl, encodeBegin, encodeEnd, ensureRowsAvailable, getCachingStrategy, getClientRowKey, getClientRowKeyManager, getCollectionModel, getCollectionModel, getContainerClientId, getCurrencyString, getEstimatedRowCount, getEstimatedRowCountConfidence, getRowCount, getRowData, getRowData, getRowIndex, getRowKey, getSortCriteria, getStamps, getVar, invokeOnComponent, isRowAvailable, isRowAvailable, isRowLocallyAvailable, isRowLocallyAvailable, isSortable, postRowDataChange, preRowDataChange, processComponent, processDecodes, processSaveState, queueEvent, resetStampState, restoreStampState, restoreState, saveStampState, saveState, setClientRowKey, setCurrencyString, setRowIndex, setRowKey, setSortCriteria, setVar, updateChildrenImpl, validateChildrenImpl

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

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processUpdates, processValidators, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, satisfiesPartialTrigger, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, validateChildren

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

addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.myfaces.trinidad.component.CollectionComponent

getFirst, getRows, getVar

Methods inherited from interface org.apache.myfaces.trinidad.model.RowKeyIndex

getRowCount, getRowData, getRowData, getRowIndex, getRowKey, isRowAvailable, isRowAvailable, setRowIndex, setRowKey

Methods inherited from interface org.apache.myfaces.trinidad.model.LocalRowKeyIndex

areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearLocalCache, getCachingStrategy, getEstimatedRowCount, getEstimatedRowCountConfidence, isRowLocallyAvailable, isRowLocallyAvailable

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

BLOCK_START_KEY

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

BLOCK_END_KEY

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

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

CONTENT_DELIVERY_KEY

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

EMPTY_TEXT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey EMPTY_TEXT_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

SELECTED_ROW_KEYS_KEY

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

SELECTION_LISTENER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SELECTION_LISTENER_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

VISIBLE_KEY

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

CONTENT_DELIVERY_LAZY

public static final java.lang.String CONTENT_DELIVERY_LAZY

See Also:

Constant Field Values

CONTENT_DELIVERY_IMMEDIATE

public static final java.lang.String CONTENT_DELIVERY_IMMEDIATE

See Also:

Constant Field Values

CONTENT_DELIVERY_WHENAVAILABLE

public static final java.lang.String CONTENT_DELIVERY_WHENAVAILABLE

See Also:

Constant Field Values

BODY_CONTEXT_MENU_FACET

public static final java.lang.String BODY_CONTEXT_MENU_FACET

See Also:

Constant Field Values

CONTEXT_MENU_FACET

public static final java.lang.String CONTEXT_MENU_FACET

See Also:

Constant Field Values

Constructor Detail

UITimelineSeries

public UITimelineSeries(java.lang.String string)

UITimelineSeries

public UITimelineSeries()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

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

getBeanType

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

Overrides:

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

createDragSource

public oracle.adf.view.rich.dnd.DragSource createDragSource(java.lang.String name,
                                                            java.util.Set<oracle.adf.view.rich.dnd.DnDAction> allowedActions,
                                                            oracle.adf.view.rich.dnd.DnDAction defaultAction,
                                                            java.lang.String discriminant,
                                                            javax.el.MethodExpression dragDropEndListener,
                                                            java.util.Map<java.lang.String,?> properties)

Specified by:

createDragSource in interface oracle.adf.view.rich.dnd.DragSourceFactory

createDragSourceBehavior

public java.lang.CharSequence createDragSourceBehavior(java.lang.String name,
                                                       oracle.adf.view.rich.dnd.DragSource dragSource,
                                                       java.util.Set<oracle.adf.view.rich.dnd.DnDAction> allowedActions,
                                                       oracle.adf.view.rich.dnd.DnDAction defaultAction,
                                                       java.lang.String discriminant,
                                                       javax.el.MethodExpression dragDropEndListener,
                                                       java.util.Map<java.lang.String,?> properties)

Specified by:

createDragSourceBehavior in interface oracle.adf.view.rich.dnd.DragSourceFactory

postCreateCollectionModel

protected void postCreateCollectionModel(org.apache.myfaces.trinidad.model.CollectionModel model)

Overrides:

postCreateCollectionModel in class org.apache.myfaces.trinidad.component.UIXCollection

getContentDelivery

public final java.lang.String getContentDelivery()

Gets whether data should be fetched when the component is rendered initially. When contentDelivery is "immediate", data is fetched and inlined into the component chrome. If contentDelivery is "lazy", data will be fetched and delivered to the client during a subsequent request.

Returns:

the new contentDelivery value

setContentDelivery

public final void setContentDelivery(java.lang.String contentDelivery)

Sets whether data should be fetched when the component is rendered initially. When contentDelivery is "immediate", data is fetched and inlined into the component chrome. If contentDelivery is "lazy", data will be fetched and delivered to the client during a subsequent request.

Parameters:

contentDelivery - the new contentDelivery value

getEmptyText

public final java.lang.String getEmptyText()

Gets the text of an empty timeline. If the text is enclosed in an open and closing html tag, it will be formatted. The formatting behavior is similar to outputFormatted component. If it is not enclosed in an open and closing html tag, it will not be formatted.

Returns:

the new emptyText value

setEmptyText

public final void setEmptyText(java.lang.String emptyText)

Sets the text of an empty timeline. If the text is enclosed in an open and closing html tag, it will be formatted. The formatting behavior is similar to outputFormatted component. If it is not enclosed in an open and closing html tag, it will not be formatted.

Parameters:

emptyText - the new emptyText value

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

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

getSelectedRowKeys

public final org.apache.myfaces.trinidad.model.RowKeySet getSelectedRowKeys()

setSelectedRowKeys

public final void setSelectedRowKeys(org.apache.myfaces.trinidad.model.RowKeySet rowKeySet)

getShortDesc

public final java.lang.String getShortDesc()

setShortDesc

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

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

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

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

addSelectionListener

public final void addSelectionListener(org.apache.myfaces.trinidad.event.SelectionListener listener)

Adds a selection listener.

Parameters:

listener - the selection listener to add

removeSelectionListener

public final void removeSelectionListener(org.apache.myfaces.trinidad.event.SelectionListener listener)

Removes a selection listener.

Parameters:

listener - the selection listener to remove

getSelectionListeners

public final org.apache.myfaces.trinidad.event.SelectionListener[] getSelectionListeners()

Returns an array of attached selection listeners.

Returns:

an array of attached selection listeners.

getSelectionListener

public final javax.el.MethodExpression getSelectionListener()

Gets a method reference to a selection listener

Returns:

the new selectionListener value

setSelectionListener

public final void setSelectionListener(javax.el.MethodExpression selectionListener)

Sets a method reference to a selection listener

Parameters:

selectionListener - the new selectionListener value

broadcast

public void broadcast(javax.faces.event.FacesEvent evt)

Internal. Application should never call this method directly.

Overrides:

broadcast in class org.apache.myfaces.trinidad.component.UIXCollection

Parameters:

evt -