Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 2 (11.1.2.2.0)

E17492-03


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

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by org.apache.myfaces.trinidad.component.UIXComponent
          extended by org.apache.myfaces.trinidad.component.UIXComponentBase
              extended by oracle.adf.view.faces.bi.component.thematicMap.UIArea

All Implemented Interfaces:
java.util.EventListener, javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class UIArea
extends org.apache.myfaces.trinidad.component.UIXComponentBase
implements javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.ValueHolder

An area is used to stamp out stylistic attributes such as colors and patterns onto the geographical areas of the Thematic Map.


Field Summary
static org.apache.myfaces.trinidad.bean.PropertyKey ACTION_EXPRESSION_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey ACTION_LISTENER_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY
           
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static org.apache.myfaces.trinidad.bean.PropertyKey CONVERTER_KEY
           
protected static java.lang.String DEFAULT_LABEL_DISPLAY
           
protected static java.lang.String DEFAULT_PATTERN
           
static org.apache.myfaces.trinidad.bean.PropertyKey DESTINATION_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey FILL_COLOR_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey FILL_PATTERN_KEY
           
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 OPACITY_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
           

 

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
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY

 

Constructor Summary
UIArea()
          Constructs an instance of UIArea

 

Method Summary
 void addActionListener(javax.faces.event.ActionListener actionListener)
          Adds an action listener.
 void broadcast(javax.faces.event.FacesEvent event)
           
 javax.faces.el.MethodBinding getAction()
           
 javax.el.MethodExpression getActionExpression()
          Gets a reference to an action method sent by the component, or the static outcome of an action.
 javax.faces.el.MethodBinding getActionListener()
          Gets a method reference to an action listener
 javax.faces.event.ActionListener[] getActionListeners()
          Returns an array of attached action listeners.
protected  org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
           
 oracle.adf.view.rich.event.ClientListenerSet getClientListeners()
          Gets a set of client listeners.
 javax.faces.convert.Converter getConverter()
          Gets a converter object
 java.lang.String getDestination()
          Gets the URI this go component references
 java.lang.String getFamily()
           
 java.awt.Color getFillColor()
          Gets the fill color of this area.
 java.lang.String getFillPattern()
          Gets the built-in pattern used to fill this area.
 java.lang.String getLabelDisplay()
          Gets the label display behavior for this area.
 java.lang.String getLabelStyle()
          Gets the font style for labels associated with this area.
 java.lang.Object getLocalValue()
           
 double getOpacity()
          Gets the opacity of the fill color of the area.
 java.lang.String getRendererType()
           
 java.lang.String getShortDesc()
          Gets the short description of this component.
 java.lang.Object getValue()
          Gets the value of the component.
 boolean isImmediate()
           
 void removeActionListener(javax.faces.event.ActionListener actionListener)
          Removes an action listener.
 void setAction(javax.faces.el.MethodBinding methodBinding)
           
 void setActionExpression(javax.el.MethodExpression methodExpression)
          Sets a reference to an action method sent by the component, or the static outcome of an action.
 void setActionListener(javax.faces.el.MethodBinding methodBinding)
          Sets a method reference to an action listener
 void setClientListeners(oracle.adf.view.rich.event.ClientListenerSet clientListeners)
          Sets a set of client listeners.
 void setConverter(javax.faces.convert.Converter converter)
          Sets a converter object
 void setDestination(java.lang.String destination)
          Sets the URI this go component references
 void setFillColor(java.awt.Color fillColor)
          Sets the fill color of this area.
 void setFillPattern(java.lang.String pattern)
          Sets the built-in pattern used to fill this area.
 void setImmediate(boolean b)
           
 void setLabelDisplay(java.lang.String labelDisplay)
          Sets the label display behavior for this area.
 void setLabelStyle(java.lang.String labelStyle)
          Sets the font style for labels associated with this area.
 void setOpacity(double opacity)
          Specifies the opacity of the fill color of the area.
 void setShortDesc(java.lang.String shortDesc)
          Sets the short description of this component.
 void setValue(java.lang.Object value)
          Sets the value of the component.

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addClientBehavior, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientBehaviors, getClientId, 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, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, subscribeToEvent, 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, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, 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

SHORT_DESC_KEY

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

FILL_COLOR_KEY

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

FILL_PATTERN_KEY

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

OPACITY_KEY

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

LABEL_DISPLAY_KEY

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

LABEL_STYLE_KEY

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

ACTION_EXPRESSION_KEY

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

ACTION_LISTENER_KEY

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

DESTINATION_KEY

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

CLIENT_LISTENERS_KEY

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

CONVERTER_KEY

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

protected static final java.lang.String DEFAULT_PATTERN
See Also:
Constant Field Values

Constructor Detail

UIArea

public UIArea()
Constructs an instance of UIArea

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

getValue

public final java.lang.Object getValue()
Gets the value of the component. When labelDisplay="on", this value will be used as the text label for this area. The provided label value will override the label coming in from the areaLayer
Specified by:
getValue in interface javax.faces.component.ValueHolder
Returns:
value of the component

setValue

public final void setValue(java.lang.Object value)
Sets the value of the component. When labelDisplay="on", this value will be used as the text label for this area. The provided label value will override the label coming in from the areaLayer
Specified by:
setValue in interface javax.faces.component.ValueHolder
Parameters:
value - value of the component

getShortDesc

public final java.lang.String getShortDesc()
Gets the short description of this component. This is used to customize the text that displays in the area's tooltip.
Returns:
short description of this component

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)
Sets the short description of this component. This is used to customize the text that displays in the area's tooltip.
Parameters:
shortDesc - short description of this component

getFillColor

public final java.awt.Color getFillColor()
Gets the fill color of this area. Valid values are RGB hexadecimal
Returns:
fill color of this area

setFillColor

public final void setFillColor(java.awt.Color fillColor)
Sets the fill color of this area. Valid values are RGB hexadecimal
Parameters:
fillColor - fill color of this area

getFillPattern

public final java.lang.String getFillPattern()
Gets the built-in pattern used to fill this area. Valid values are: "smallDiagonalLeft" "smallChecker" "smallDiagonalRight" "smallTriangle" "smallCrosshatch" "smallDiamond" "largeDiagonalLeft" "largeChecker" "largeDiagonalRight" "largeTriangle" "largeCrosshatch" "largeDiamond" The pattern is drawn with a white background, and the foreground color is taken from the fillColor attribute.
Returns:
pattern used to fill the area

setFillPattern

public final void setFillPattern(java.lang.String pattern)
Sets the built-in pattern used to fill this area. Valid values are: "smallDiagonalLeft" "smallChecker" "smallDiagonalRight" "smallTriangle" "smallCrosshatch" "smallDiamond" "largeDiagonalLeft" "largeChecker" "largeDiagonalRight" "largeTriangle" "largeCrosshatch" "largeDiamond" The pattern is drawn with a white background, and the foreground color is taken from the fillColor attribute.
Parameters:
pattern - pattern used to fill the area

getOpacity

public final double getOpacity()
Gets the opacity of the fill color of the area. Valid values are from 0.0 - 1.0, where 0.0 is transparent and 1.0 is opaque.
Returns:
opacity of the area

setOpacity

public final void setOpacity(double opacity)
Specifies the opacity of the fill color of the area. Valid values are from 0.0 - 1.0, where 0.0 is transparent and 1.0 is opaque.
Parameters:
opacity - opacity of the area

getLabelDisplay

public final java.lang.String getLabelDisplay()
Gets the label display behavior for this area. Valid values are: "on" - Display the label provided in the value attribute in place of the built-in basemap labels "off" - (default) Do not display the label provided in the value attribute
Returns:
label display behavior for this area

setLabelDisplay

public final void setLabelDisplay(java.lang.String labelDisplay)
Sets the label display behavior for this area. Valid values are: "on" - Display the label provided in the value attribute in plaec of the built-in basemap labels "off" - (default) Do not display the label provided in the value attribute
Parameters:
labelDisplay - label display behavior for this area

getLabelStyle

public final java.lang.String getLabelStyle()
Gets the font style for labels associated with this area. Accepts font-related CSS attributes like font-name, font-weight, font-size, color, etc.
Returns:
font style for labels associated with this area

setLabelStyle

public final void setLabelStyle(java.lang.String labelStyle)
Sets the font style for labels associated with this area. Accepts font-related CSS attributes like font-name, font-weight, font-size, color, etc.
Parameters:
labelStyle - font style for labels associated with this area

getAction

public javax.faces.el.MethodBinding getAction()
Specified by:
getAction in interface javax.faces.component.ActionSource

setAction

public void setAction(javax.faces.el.MethodBinding methodBinding)
Specified by:
setAction in interface javax.faces.component.ActionSource

getActionListener

public javax.faces.el.MethodBinding getActionListener()
Gets a method reference to an action listener
Specified by:
getActionListener in interface javax.faces.component.ActionSource
Returns:
the new actionListener value

setActionListener

public void setActionListener(javax.faces.el.MethodBinding methodBinding)
Sets a method reference to an action listener
Specified by:
setActionListener in interface javax.faces.component.ActionSource
Parameters:
methodBinding - the new actionListener value

isImmediate

public boolean isImmediate()
Specified by:
isImmediate in interface javax.faces.component.ActionSource

setImmediate

public void setImmediate(boolean b)
Specified by:
setImmediate in interface javax.faces.component.ActionSource

addActionListener

public void addActionListener(javax.faces.event.ActionListener actionListener)
Adds an action listener.
Specified by:
addActionListener in interface javax.faces.component.ActionSource
Parameters:
actionListener - the action listener to add

getActionListeners

public javax.faces.event.ActionListener[] getActionListeners()
Returns an array of attached action listeners.
Specified by:
getActionListeners in interface javax.faces.component.ActionSource
Returns:
an array of attached action listeners.

removeActionListener

public void removeActionListener(javax.faces.event.ActionListener actionListener)
Removes an action listener.
Specified by:
removeActionListener in interface javax.faces.component.ActionSource
Parameters:
actionListener - the action listener to remove

getActionExpression

public javax.el.MethodExpression getActionExpression()
Gets a reference to an action method sent by the component, or the static outcome of an action.
Specified by:
getActionExpression in interface javax.faces.component.ActionSource2
Returns:
the new actionExpression value

setActionExpression

public void setActionExpression(javax.el.MethodExpression methodExpression)
Sets a reference to an action method sent by the component, or the static outcome of an action.
Specified by:
setActionExpression in interface javax.faces.component.ActionSource2
Parameters:
methodExpression - the new actionExpression value

getDestination

public final java.lang.String getDestination()
Gets the URI this go component references
Returns:
the new destination value

setDestination

public final void setDestination(java.lang.String destination)
Sets the URI this go component references
Parameters:
destination - the new destination 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

getLocalValue

public java.lang.Object getLocalValue()
Specified by:
getLocalValue in interface javax.faces.component.ValueHolder

getConverter

public javax.faces.convert.Converter getConverter()
Gets a converter object
Specified by:
getConverter in interface javax.faces.component.ValueHolder
Returns:
the new converter value

setConverter

public void setConverter(javax.faces.convert.Converter converter)
Sets a converter object
Specified by:
setConverter in interface javax.faces.component.ValueHolder
Parameters:
converter - the new converter value

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 2 (11.1.2.2.0)

E17492-03


Copyright © 1997, 2012, Oracle. All rights reserved.