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

Class UICustomArea

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.thematicMap.UICustomArea

All Implemented Interfaces:

java.util.EventListener, 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 UICustomArea
extends org.apache.myfaces.trinidad.component.UIXComponentBase

A Custom Area is a child of the Custom Area Layer and is used to specify the lower level regions from the built-in basemap that will be aggregated to form the new area

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.myfaces.trinidad.bean.PropertyKey	AREA_ID_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	AREA_LIST_KEY
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	DESCRIPTION_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LABEL_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE

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
UICustomArea() Constructs an instance of UICustomArea

Method Summary

Methods

Modifier and Type	Method and Description
void	broadcast(javax.faces.event.FacesEvent event)
java.lang.String	getAreaId() Gets the unique stamped id for this custom area
java.lang.String	getAreaList() Gets the comma separated list of values for the aggregated base layer regions that make up this custom area
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
java.lang.String	getDescription() Gets the description for this custom area
java.lang.String	getFamily()
java.lang.String	getLabel() Gets the text label for this custom area
java.lang.String	getRendererType()
void	setAreaId(java.lang.String areaId) Specifies the unique stamped id for this cusotm area
void	setAreaList(java.lang.String areaList) Specifies the comma separated list of values for the aggregated base layer regions that make up this custom area
void	setDescription(java.lang.String description) Sets the description for this custom area
void	setLabel(java.lang.String label) Sets the text label for this custom area

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

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addClientBehavior, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, 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, 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, clearCachedClientIds, clearCachedClientIds, 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, 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

TYPE

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

LABEL_KEY

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

DESCRIPTION_KEY

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

AREA_ID_KEY

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

AREA_LIST_KEY

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

UICustomArea

public UICustomArea()

Constructs an instance of UICustomArea

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

broadcast

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

Overrides:

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

Throws:

javax.faces.event.AbortProcessingException

getLabel

public final java.lang.String getLabel()

Gets the text label for this custom area

Returns:

label for this component

setLabel

public final void setLabel(java.lang.String label)

Sets the text label for this custom area

Parameters:

label - label for this component

getDescription

public final java.lang.String getDescription()

Gets the description for this custom area

Returns:

description for this component

setDescription

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

Sets the description for this custom area

Parameters:

description - description for this component

getAreaId

public final java.lang.String getAreaId()

Gets the unique stamped id for this custom area

Returns:

unique id for this custom area

setAreaId

public final void setAreaId(java.lang.String areaId)

Specifies the unique stamped id for this cusotm area

Parameters:

areaId - unique id for this custom area

getAreaList

public final java.lang.String getAreaList()

Gets the comma separated list of values for the aggregated base layer regions that make up this custom area

Returns:

list of base layer regions that make up this custom area

setAreaList

public final void setAreaList(java.lang.String areaList)

Specifies the comma separated list of values for the aggregated base layer regions that make up this custom area

Parameters:

areaList - list of base layer regions that make up this custom area