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

Class UIAreaLayer

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

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 UIAreaLayer
extends org.apache.myfaces.trinidad.component.UIXComponentBase
implements javax.faces.component.NamingContainer

The Area Layer is a child of the Thematic Map and is used to customize which layers from the built-in basemap get displayed. Each Area Layer points to a layer from the basemap, i.e. "states" or "counties", and only the layers for which an Area Layer is present will get rendered. Data then gets associated with a basemap layer by nesting the appropriate data layer within an Area Layer.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_LISTENERS_KEY
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
protected static java.lang.String	DEFAULT_LABEL_DISPLAY
protected static java.lang.String	DEFAULT_LABEL_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	LABEL_DISPLAY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LABEL_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LABEL_TYPE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LAYER_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	STYLE_CLASS_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

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor and Description
UIAreaLayer() Constructs an instance of UIAreaLayer

Method Summary

Methods

Modifier and Type	Method and Description
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
oracle.adf.view.rich.event.ClientListenerSet	getClientListeners() Gets a set of client listeners.
java.lang.String	getFamily()
java.lang.String	getLabelDisplay() Determines how built-in basemap labels for this layer should be displayed.
java.lang.String	getLabelStyle() Gets the font style for labels on this layer.
java.lang.String	getLabelType() Determines which of the built-in basemap labels to display.
java.lang.String	getLayer() Gets the name of a layer from the built-in basemap.
java.lang.String	getRendererType()
java.lang.String	getStyleClass() Gets the CSS style class to use for this component
void	setClientListeners(oracle.adf.view.rich.event.ClientListenerSet clientListeners) Sets a set of client listeners.
void	setLabelDisplay(java.lang.String labelDisplay) Specifies how built-in basemap labels for this layer should be displayed.
void	setLabelStyle(java.lang.String labelStyle) Sets the font style for labels on this layer.
void	setLabelType(java.lang.String labelType) Specifies which of the built-in basemap labels to display.
void	setLayer(java.lang.String layer) Sets the name of a layer from the built-in basemap.
void	setStyleClass(java.lang.String styleClass) Sets the CSS style class to use for this component

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

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addClientBehavior, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcast, 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

LAYER_KEY

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

LABEL_DISPLAY_KEY

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

LABEL_TYPE_KEY

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

LABEL_STYLE_KEY

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

CLIENT_LISTENERS_KEY

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

STYLE_CLASS_KEY

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

protected static final java.lang.String DEFAULT_LABEL_DISPLAY

See Also:

Constant Field Values

DEFAULT_LABEL_TYPE

protected static final java.lang.String DEFAULT_LABEL_TYPE

See Also:

Constant Field Values

Constructor Detail

UIAreaLayer

public UIAreaLayer()

Constructs an instance of UIAreaLayer

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

getLayer

public final java.lang.String getLayer()

Gets the name of a layer from the built-in basemap. Allowable values depends on the basemap specified in the Thematic Map. For example, for basemap="usa", valid layers are "country", "states", and "counties".

Returns:

Name of the layer from the basemap

setLayer

public final void setLayer(java.lang.String layer)

Sets the name of a layer from the built-in basemap. Allowable values depends on the basemap specified in the Thematic Map. For example, for basemap="usa", valid layers are "country", "states", and "counties".

Parameters:

layer - Name of the layer from the basemap

getLabelDisplay

public final java.lang.String getLabelDisplay()

Determines how built-in basemap labels for this layer should be displayed. Valid values are: "auto" - (default) For each basemap region, display the label if there is sufficient space in the region. "on" - Display the basemap labels for all regions of this layer. "off" - Do not display any basemap labels for this layer.

Returns:

label display behavior for this layer

setLabelDisplay

public final void setLabelDisplay(java.lang.String labelDisplay)

Specifies how built-in basemap labels for this layer should be displayed. Valid values are: "auto" - (default) For each basemap region, display the label if there is sufficient space in the region. "on" - Display the basemap labels for all regions of this layer. "off" - Do not display any basemap labels for this layer.

Parameters:

labelDisplay - label display behavior for this layer

getLabelType

public final java.lang.String getLabelType()

Determines which of the built-in basemap labels to display. Valid values are: "short" - (default) Use the short labels defined in the basemap ex) "MA" "long" - Use the long labels defined in the basemap ex) "Massachusetts"

Returns:

type of labels to display

setLabelType

public final void setLabelType(java.lang.String labelType)

Specifies which of the built-in basemap labels to display. Valid values are: "short" - (default) Use the short labels defined in the basemap ex) "MA" "long" - Use the long labels defined in the basemap ex) "Massachusetts"

Parameters:

labelType - type of labels to display

getLabelStyle

public final java.lang.String getLabelStyle()

Gets the font style for labels on this layer. Accepts font-related CSS attributes like font-name, font-weight, font-size, color, etc.

Returns:

font style for labels on this layer

setLabelStyle

public final void setLabelStyle(java.lang.String labelStyle)

Sets the font style for labels on this layer. Accepts font-related CSS attributes like font-name, font-weight, font-size, color, etc.

Parameters:

labelStyle - font style for labels on this layer

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 java.lang.String getStyleClass()

Gets the CSS style class to use for this component

Returns:

the thematic map's style class

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Sets the CSS style class to use for this component

Parameters:

styleClass - the thematic map's style class