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

Class UICustomAreaLayer

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.UICustomAreaLayer

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.NamingContainer, 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 UICustomAreaLayer
extends org.apache.myfaces.trinidad.component.UIXCollection

The Custom Area Layer is a child of the Thematic Map which lets developers create a new area layer from their own region data and insert it into the hierarchy. The newly created layer always gets added above the 'extendsLayer' in the layer hierarchy, and can be used in the same way as any other areaLayer

Nested Class Summary

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

org.apache.myfaces.trinidad.component.UIXCollection.NoColumnFacetsVisitContext

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 java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	EXTENDS_LAYER_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

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

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor and Description
UICustomAreaLayer() Constructs an instance of UICustomAreaLayer

Method Summary

Methods

Modifier and Type	Method and Description
void	broadcast(javax.faces.event.FacesEvent event)
void	clearCachedClientIds()
protected org.apache.myfaces.trinidad.model.CollectionModel	createCollectionModel(org.apache.myfaces.trinidad.model.CollectionModel current, java.lang.Object value)
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.lang.String	getExtendsLayer() Gets the name of the layer that this custom area layer aggregates from
java.lang.String	getFamily()
org.apache.myfaces.trinidad.model.CollectionModel	getModel()
java.lang.String	getRendererType()
java.lang.String	getShortDesc() Gets the short description for this custom area layer
java.lang.Object	getValue() Gets the data model being used by this custom area layer.
java.lang.String	getVarStatus()
protected void	processFacetsAndChildren(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId)
void	setExtendsLayer(java.lang.String extendsLayer) Specifies the name of the layer that this custom area layer aggregates from
void	setShortDesc(java.lang.String description) Sets the short description for this custom area layer
void	setValue(java.lang.Object value) Sets the data model being used by this custom area layer.
void	setVarStatus(java.lang.String varStatus)
protected boolean	visitData(javax.faces.component.visit.VisitContext visitContext, javax.faces.component.visit.VisitCallback callback)

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

areRowsAvailable, areRowsAvailable, areRowsAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearCurrencyStringCache, clearLocalCache, createVarStatusMap, decodeChildrenImpl, defaultVisitChildren, encodeBegin, encodeEnd, ensureRowsAvailable, getCachingStrategy, getClientRowKey, getClientRowKeyManager, getCollectionModel, getCollectionModel, getContainerClientId, getCurrencyString, getEstimatedRowCount, getEstimatedRowCountConfidence, getRowCount, getRowData, getRowData, getRowData, getRowIndex, getRowKey, getSortCriteria, getStamps, getVar, invokeOnComponent, isRowAvailable, isRowAvailable, isRowAvailable, isRowLocallyAvailable, isRowLocallyAvailable, isSortable, postCreateCollectionModel, postRowDataChange, preRowDataChange, processComponent, processDecodes, processEvent, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, resetStampState, restoreStampState, restoreState, saveStampState, saveState, setClientRowKey, setCurrencyString, setRowIndex, setRowKey, setSortCriteria, setupELVariable, setupVisitingContext, setVar, tearDownVisitingContext, updateChildrenImpl, validateChildrenImpl, visitChildren, visitChildrenWithoutIterating, visitUnstampedFacets

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

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addClientBehavior, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, createFacesBean, decode, decodeChildren, encodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientBehaviors, getClientId, getComponentChangeFilters, getContainerClientId, getDefaultEventName, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, satisfiesPartialTrigger, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setupFlattenedChildrenContext, setupFlattenedContext, setValueBinding, setValueExpression, subscribeToEvent, tearDownFlattenedChildrenContext, tearDownFlattenedContext, toString, unsubscribeFromEvent, updateChildren, validateChildren

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, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, visitAllChildren, visitChildren, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInView

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

EXTENDS_LAYER_KEY

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

SHORT_DESC_KEY

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

VAR_STATUS_KEY

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

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

UICustomAreaLayer

public UICustomAreaLayer()

Constructs an instance of UICustomAreaLayer

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()

Overrides:

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

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

getValue

public final java.lang.Object getValue()

Gets the data model being used by this custom area 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 customAreaLayer 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 custom area layer

setValue

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

Sets the data model being used by this custom area 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 customAreaLayer will automatically convert the instance into a CollectionModel.

Parameters:

value - data model used by this custom area layer

getExtendsLayer

public final java.lang.String getExtendsLayer()

Gets the name of the layer that this custom area layer aggregates from

Returns:

name of the layer to extend from

setExtendsLayer

public final void setExtendsLayer(java.lang.String extendsLayer)

Specifies the name of the layer that this custom area layer aggregates from

Parameters:

extendsLayer - name of the layer to extend from

getShortDesc

public final java.lang.String getShortDesc()

Gets the short description for this custom area layer

Returns:

short description for this component

setShortDesc

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

Sets the short description for this custom area layer

Parameters:

description - short description for this component

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

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)

visitData

protected boolean visitData(javax.faces.component.visit.VisitContext visitContext,
                javax.faces.component.visit.VisitCallback callback)

Specified by:

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