Skip navigation links

oracle.adf.view.faces.bi.component.thematicMap
Class UIDataLayer

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
oracle.adf.view.faces.bi.component.thematicMap.UIDataLayer

All Implemented Interfaces:

javax.faces.component.NamingContainer, javax.faces.component.StateHolder

Direct Known Subclasses:

UIAreaDataLayer, UIPointDataLayer

public class UIDataLayer

extends org.apache.myfaces.trinidad.component.UIXCollection

Field Summary

static org.apache.myfaces.trinidad.bean.PropertyKey	ANIMATION_DATACHANGE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ANIMATION_DURATION_KEY
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	CONTENT_DELIVERY_KEY
protected static java.lang.String	DEFAULT_ANIMATIONONLAYERCHANGE
protected static java.lang.String	DEFAULT_CONTENT_DELIVERY_MODE
protected static java.lang.String	DEFAULT_SELECTION_MODE
static org.apache.myfaces.trinidad.bean.PropertyKey	DISCLOSED_ROW_KEYS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	EMPTY_TEXT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_TRIGGERS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	POPUP_CONTEXT_ROW_KEY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ROW_DISCLOSURE_LISTENER_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	SELECTION_MODE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHORT_DESC_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	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 javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

UIDataLayer()

UIDataLayer(java.lang.String rendererType)

Method Summary

void	addRowDisclosureListener(org.apache.myfaces.trinidad.event.RowDisclosureListener listener) Adds a rowDisclosure listener.
void	addSelectionListener(org.apache.myfaces.trinidad.event.SelectionListener listener) Adds a selection listener.
void	broadcast(javax.faces.event.FacesEvent event)
protected void	broadcastActionEvent(ThematicMapActionEvent ae)
void	clearCachedClientIds()
protected org.apache.myfaces.trinidad.model.CollectionModel	createCollectionModel(org.apache.myfaces.trinidad.model.CollectionModel current, java.lang.Object value)
int	getAnimationDuration() Gets the animation duration in milliseconds.
java.lang.String	getAnimationOnDataChange() Gets the type of animation to apply when the value of an dataLayer changes.
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.lang.String	getContentDelivery() Gets whether data should be fetched when the component is rendered initially.
org.apache.myfaces.trinidad.model.RowKeySet	getDisclosedRowKeys() Gets the disclosed state for this component.
java.lang.String	getEmptyText() Gets the text to display in the legend when the data layer has no data
java.lang.String	getFamily()
org.apache.myfaces.trinidad.model.CollectionModel	getModel()
java.lang.String[]	getPartialTriggers() Retrieves the ids of the partial triggers for the data layer
protected java.lang.Object	getPopupContextRowKey() For internal use only
java.lang.String	getRendererType()
javax.el.MethodExpression	getRowDisclosureListener() Gets a method reference to an ExpansionListener
org.apache.myfaces.trinidad.event.RowDisclosureListener[]	getRowDisclosureListeners() Returns an array of attached rowDisclosure listeners.
org.apache.myfaces.trinidad.model.RowKeySet	getSelectedRowKeys() Gets the selection state for this component.
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	getSelectionMode() Gets whether stamps in the data layer can be selected or not.
java.lang.String	getShortDesc() Gets the short description for the component
java.lang.Object	getValue() Gets the data model being used by this data layer.
java.lang.String	getVarStatus()
boolean	invokeOnComponent(javax.faces.context.FacesContext context, java.lang.String clientId, javax.faces.component.ContextCallback callback)
protected void	postCreateCollectionModel(org.apache.myfaces.trinidad.model.CollectionModel model)
protected void	processFacetsAndChildren(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId)
void	removeRowDisclosureListener(org.apache.myfaces.trinidad.event.RowDisclosureListener listener) Removes a rowDisclosure listener.
void	removeSelectionListener(org.apache.myfaces.trinidad.event.SelectionListener listener) Removes a selection listener.
void	setAnimationDuration(int animationDuration) Specifies the animation duration in milliseconds.
void	setAnimationOnDataChange(java.lang.String animationOnDataChange) Specifies the type of animation to apply when the value of a dataLayer changes.
void	setContentDelivery(java.lang.String contentDelivery) Specifies whether data should be fetched when the component is rendered initially.
void	setDisclosedRowKeys(org.apache.myfaces.trinidad.model.RowKeySet disclosedRowKeys) Sets the disclosed state for this component.
void	setEmptyText(java.lang.String emptyText) Sets the text to display in the legend when the data layer has no data
void	setPartialTriggers(java.lang.String[] partialTriggers) Specifies the ids of the partial triggers for the data layer
void	setRowDisclosureListener(javax.el.MethodExpression rowDisclosureListener) Sets a method reference to an ExpansionListener
void	setSelectedRowKeys(org.apache.myfaces.trinidad.model.RowKeySet selectedRowKeys) Sets the selection state for this component.
void	setSelectionListener(javax.el.MethodExpression selectionListener) Sets a method reference to a selection listener
void	setSelectionMode(java.lang.String selectionMode) Specifies whether stamps in the data layer can be selected or not.
void	setShortDesc(java.lang.String shortDesc) Sets the short description for the component
protected void	setupVisitingContext(javax.faces.context.FacesContext context)
void	setValue(java.lang.Object value) Sets the data model being used by this data layer.
void	setVarStatus(java.lang.String varStatus) For internal use only
protected void	tearDownVisitingContext(javax.faces.context.FacesContext context)

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

areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearCurrencyStringCache, clearLocalCache, createVarStatusMap, decodeChildrenImpl, encodeBegin, encodeEnd, ensureRowsAvailable, getCachingStrategy, getClientRowKey, getClientRowKeyManager, getCollectionModel, getCollectionModel, getContainerClientId, getCurrencyString, getEstimatedRowCount, getEstimatedRowCountConfidence, getRowCount, getRowData, getRowData, getRowIndex, getRowKey, getSortCriteria, getStamps, getVar, isRowAvailable, isRowAvailable, isRowLocallyAvailable, isRowLocallyAvailable, isSortable, postRowDataChange, preRowDataChange, processComponent, processDecodes, processSaveState, queueEvent, resetStampState, restoreStampState, restoreState, saveStampState, saveState, setClientRowKey, setCurrencyString, setRowIndex, setRowKey, setSortCriteria, setupELVariable, 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, encodeChildren, 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, getRendersChildren, 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, defaultGetRenderedFacetsAndChildren, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, tearDownEncodingContext, visitTree, 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

Field Detail

TYPE

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

VALUE_KEY

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

VAR_STATUS_KEY

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

PARTIAL_TRIGGERS_KEY

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

ANIMATION_DATACHANGE_KEY

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

ANIMATION_DURATION_KEY

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

SELECTION_MODE_KEY

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

CONTENT_DELIVERY_KEY

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

POPUP_CONTEXT_ROW_KEY_KEY

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

DISCLOSED_ROW_KEYS_KEY

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

ROW_DISCLOSURE_LISTENER_KEY

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

EMPTY_TEXT_KEY

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

SHORT_DESC_KEY

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

DEFAULT_SELECTION_MODE

protected static final java.lang.String DEFAULT_SELECTION_MODE

See Also:

Constant Field Values

DEFAULT_CONTENT_DELIVERY_MODE

protected static final java.lang.String DEFAULT_CONTENT_DELIVERY_MODE

See Also:

Constant Field Values

DEFAULT_ANIMATIONONLAYERCHANGE

protected static final java.lang.String DEFAULT_ANIMATIONONLAYERCHANGE

See Also:

Constant Field Values

Constructor Detail

UIDataLayer

public UIDataLayer()

UIDataLayer

public UIDataLayer(java.lang.String rendererType)

Method Detail

getFamily

public java.lang.String getFamily()

Specified by:

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

getRendererType

public java.lang.String getRendererType()

Overrides:

getRendererType 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

clearCachedClientIds

public void clearCachedClientIds()

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException

Overrides:

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

Throws:

javax.faces.event.AbortProcessingException

broadcastActionEvent

protected void broadcastActionEvent(ThematicMapActionEvent ae)

getContentDelivery

public final java.lang.String getContentDelivery()

Gets whether data should be fetched when the component is rendered initially. Valid values are: "immediate"- data is fetched and inlined into the component chrome "lazy" - data will be fetched and delivered to the client during a subsequent request "whenAvailable" - (default) upon initial rendering, the renderer queries the model for available data. Data is fetched and rendered immediately if model indicates that data is available. So contentDelivery="whenAvailable" behaves like "immediate" if data is available upon initial rendering, otherwise "lazy" content delivery is used.

Returns:

the content delivery mode

setContentDelivery

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

Specifies whether data should be fetched when the component is rendered initially. Valid values are: "immediate"- data is fetched and inlined into the component chrome "lazy" - data will be fetched and delivered to the client during a subsequent request "whenAvailable" - (default) upon initial rendering, the renderer queries the model for available data. Data is fetched and rendered immediately if model indicates that data is available. So contentDelivery="whenAvailable" behaves like "immediate" if data is available upon initial rendering, otherwise "lazy" content delivery is used.

Parameters:

contentDelivery - the content delivery mode

getVarStatus

public final java.lang.String getVarStatus()

Specified by:

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

setVarStatus

public final void setVarStatus(java.lang.String varStatus)

For internal use only

For internal use only. Application developers should not use this

setAnimationOnDataChange

public void setAnimationOnDataChange(java.lang.String animationOnDataChange)

Specifies the type of animation to apply when the value of a dataLayer changes. Valid values are: "none" "alphaFade" "conveyorFromLeft" "conveyorFromRight" "cubeToLeft" "cubeToRight" "flipLeft" "flipRight" "slideToLeft" "slideToRight" "transitionToLeft" "transitionToRight" "zoom"

Parameters:

animationOnDataChange - the type of animation to apply a dataLayer change

getAnimationOnDataChange

public java.lang.String getAnimationOnDataChange()

Gets the type of animation to apply when the value of an dataLayer changes. Valid values are: "none" "alphaFade" "conveyorFromLeft" "conveyorFromRight" "cubeToLeft" "cubeToRight" "flipLeft" "flipRight" "slideToLeft" "slideToRight" "transitionToLeft" "transitionToRight" "zoom"

Returns:

the type of animation to apply on dataLayer change

setAnimationDuration

public void setAnimationDuration(int animationDuration)

Specifies the animation duration in milliseconds.

Parameters:

animationDuration - animation duration in milliseconds

getAnimationDuration

public int getAnimationDuration()

Gets the animation duration in milliseconds. The default value is 1000.

Returns:

animation duration in milliseconds

getEmptyText

public final java.lang.String getEmptyText()

Gets the text to display in the legend when the data layer has no data

Returns:

text to display in legend

setEmptyText

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

Sets the text to display in the legend when the data layer has no data

Parameters:

emptyText - text to display in legend

getShortDesc

public final java.lang.String getShortDesc()

Gets the short description for the component

Returns:

short description for the component

setShortDesc

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

Sets the short description for the component

Parameters:

shortDesc - short description for the component

getSelectionMode

public final java.lang.String getSelectionMode()

Gets whether stamps in the data layer can be selected or not. Valid values are: "single" - Only 1 stamp can be selected at a time "multiple" - Multiples stamps can be selected at a time "none" - No selection allowed

Returns:

selection mode for the data layer

setSelectionMode

public final void setSelectionMode(java.lang.String selectionMode)

Specifies whether stamps in the data layer can be selected or not. Valid values are: "single" - Only 1 stamp can be selected at a time "multiple" - Multiples stamps can be selected at a time "none" - No selection allowed

Parameters:

selectionMode - selection mode for the data layer

getSelectedRowKeys

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

Gets the selection state for this component.

Returns:

the new selectedRowKeys value

setSelectedRowKeys

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

Sets the selection state for this component.

Parameters:

selectedRowKeys - the new selectedRowKeys value

getDisclosedRowKeys

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

Gets the disclosed state for this component.

Returns:

the new disclosedRowKeys value

setDisclosedRowKeys

public final void setDisclosedRowKeys(org.apache.myfaces.trinidad.model.RowKeySet disclosedRowKeys)

Sets the disclosed state for this component.

Parameters:

disclosedRowKeys - the new disclosedRowKeys value

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

getSelectionListeners

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

Returns an array of attached selection listeners.

Returns:

an array of attached selection listeners.

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

getPartialTriggers

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

Retrieves the ids of the partial triggers for the data layer

Returns:

the ids of the partial triggers for this component

setPartialTriggers

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

Specifies the ids of the partial triggers for the data layer

Parameters:

partialTriggers - the ids of the partial triggers for this component

getValue

public final java.lang.Object getValue()

Gets the data model being used by this data layer. The specific model class is org.apache.myfaces.trinidad.model.CollectionModel. You may also use other model instances, e.g., java.util.List , array, and javax.faces.model.DataModel. The data layer will automatically convert the instance into a CollectionModel.

Specified by:

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

Returns:

data model used by this data layer

setValue

public final void setValue(java.lang.Object value)

Sets the data model being used by this data layer. The specific model class is org.apache.myfaces.trinidad.model.CollectionModel. You may also use other model instances, e.g., java.util.List , array, and javax.faces.model.DataModel. The data layer will automatically convert the instance into a CollectionModel.

Parameters:

value - data model used by this data layer

getRowDisclosureListener

public final javax.el.MethodExpression getRowDisclosureListener()

Gets a method reference to an ExpansionListener

Returns:

the new rowDisclosureListener value

setRowDisclosureListener

public final void setRowDisclosureListener(javax.el.MethodExpression rowDisclosureListener)

Sets a method reference to an ExpansionListener

Parameters:

rowDisclosureListener - the new rowDisclosureListener value

getRowDisclosureListeners

public final org.apache.myfaces.trinidad.event.RowDisclosureListener[] getRowDisclosureListeners()

Returns an array of attached rowDisclosure listeners.

Returns:

an array of attached rowDisclosure listeners.

addRowDisclosureListener

public final void addRowDisclosureListener(org.apache.myfaces.trinidad.event.RowDisclosureListener listener)

Adds a rowDisclosure listener.

Parameters:

listener - the rowDisclosure listener to add

removeRowDisclosureListener

public final void removeRowDisclosureListener(org.apache.myfaces.trinidad.event.RowDisclosureListener listener)

Removes a rowDisclosure listener.

Parameters:

listener - the rowDisclosure listener to remove

processFacetsAndChildren

protected void processFacetsAndChildren(javax.faces.context.FacesContext context,
                                        javax.faces.event.PhaseId phaseId)

Specified by:

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

getModel

public org.apache.myfaces.trinidad.model.CollectionModel getModel()

createCollectionModel

protected org.apache.myfaces.trinidad.model.CollectionModel createCollectionModel(org.apache.myfaces.trinidad.model.CollectionModel current,
                                                                                  java.lang.Object value)

Specified by:

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

postCreateCollectionModel

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

Overrides:

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

getPopupContextRowKey

protected final java.lang.Object getPopupContextRowKey()

For internal use only

For internal use only. Application developers should not use this

invokeOnComponent

public boolean invokeOnComponent(javax.faces.context.FacesContext context,
                                 java.lang.String clientId,
                                 javax.faces.component.ContextCallback callback)
                          throws javax.faces.FacesException

Overrides:

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

Throws:

javax.faces.FacesException

setupVisitingContext

protected void setupVisitingContext(javax.faces.context.FacesContext context)

Overrides:

setupVisitingContext in class org.apache.myfaces.trinidad.component.UIXComponent

tearDownVisitingContext

protected void tearDownVisitingContext(javax.faces.context.FacesContext context)

Overrides:

tearDownVisitingContext in class org.apache.myfaces.trinidad.component.UIXComponent

Skip navigation links