oracle.adf.view.faces.bi.component.common
Class UIMarker

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.common.UIMarker

All Implemented Interfaces:

javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.StateHolder, javax.faces.component.ValueHolder

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

A marker is used to stamp out built-in or custom shapes associated with data points. Markers can be customized with different stylistic attributes such as colors and patterns based ontheir underlying data.

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_GRADIENT_EFFECT
protected static java.lang.String	DEFAULT_LABEL_DISPLAY
protected static java.lang.String	DEFAULT_LABEL_POSITION
protected static java.lang.String	DEFAULT_PATTERN
protected static double	DEFAULT_SCALE
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	GRADIENT_EFFECT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LABEL_DISPLAY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LABEL_POSITION_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	SCALE_X_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SCALE_Y_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHAPE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHAPE_PATH_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

bindings

Constructor Summary

UIMarker()
Constructs and instance of UIMarker

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 marker.
java.lang.String	getFillPattern() Gets the built-in pattern used to fill this marker.
java.lang.String	getGradientEffect() Gets the gradient effect that should be used for this marker.
java.lang.String	getLabelDisplay() Gets the label display behavior for this marker.
java.lang.String	getLabelPosition() Gets the position relative to the marker that the specified value label should be displayed at.
java.lang.String	getLabelStyle() Gets the font style for labels associated with this marker.
java.lang.Object	getLocalValue()
double	getOpacity() Gets the opacity of the fill color of the marker.
java.lang.String	getRendererType()
double	getScaleX() Gets the horizontal scale factor for this marker.
double	getScaleY() Gets the vertical scale factor for this marker.
java.lang.String	getShape() Gets the shape of the marker.
java.lang.String	getShapePath() Gets the path to the svg file to use as a custom shape
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 marker.
void	setFillPattern(java.lang.String pattern) Sets the built-in pattern used to fill this marker.
void	setGradientEffect(java.lang.String gradientEffect) Specifies the gradient effect that should be used for this marker.
void	setImmediate(boolean b)
void	setLabelDisplay(java.lang.String labelDisplay) Sets the label display behavior for this marker.
void	setLabelPosition(java.lang.String labelPosition) Sets the position relative to the marker that the specified value label should be displayed at.
void	setLabelStyle(java.lang.String labelStyle) Sets the font style for labels associated with this marker.
void	setOpacity(double opacity) Specifies the opacity of the fill color of the marker.
void	setScaleX(double scaleX) Sets the horizontal scale factor for this marker.
void	setScaleY(double scaleY) Gets the vertical scale factor for this marker.
void	setShape(java.lang.String shape) Specifies the shape of the marker.
void	setShapePath(java.lang.String shapePath) Specifies the path to the svg file to use as a custom shape
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, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, 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, 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, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

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

addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId

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

SHAPE_KEY

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

SHAPE_PATH_KEY

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

SCALE_X_KEY

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

SCALE_Y_KEY

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

GRADIENT_EFFECT_KEY

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

LABEL_DISPLAY_KEY

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

LABEL_POSITION_KEY

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

DEFAULT_GRADIENT_EFFECT

protected static final java.lang.String DEFAULT_GRADIENT_EFFECT

See Also:

Constant Field Values

DEFAULT_LABEL_DISPLAY

protected static final java.lang.String DEFAULT_LABEL_DISPLAY

See Also:

Constant Field Values

DEFAULT_LABEL_POSITION

protected static final java.lang.String DEFAULT_LABEL_POSITION

See Also:

Constant Field Values

DEFAULT_SCALE

protected static final double DEFAULT_SCALE

See Also:

Constant Field Values

DEFAULT_PATTERN

protected static final java.lang.String DEFAULT_PATTERN

See Also:

Constant Field Values

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

UIMarker

public UIMarker()

Constructs and instance of UIMarker

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

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

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()

Overrides:

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

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 marker

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 marker

Specified by:

setValue in interface javax.faces.component.ValueHolder

Parameters:

value - value of the component

getShape

public final java.lang.String getShape()

Gets the shape of the marker. The predefined shapes are : "circle" (default) "square" "plus" "diamond" "triangleUp" "triangleDown" "human" If the shape starts with "custom" prefix, then the shape will be defined by the svg file specified in the skin file. For example if the shape is customFoo then the skin file should have a .AFDVTShapeCustomFoo:alias selector defined or the Thematic Map specific af|dvt-thematicMap::shape-customFoo defined which has the -tr-path property pointing to the svg file.

Returns:

the shape of the marker

setShape

public final void setShape(java.lang.String shape)

Specifies the shape of the marker. The predefined shapes are : "circle" (default) "square" "plus" "diamond" "triangleUp" "triangleDown" "human" If the shape starts with "custom" prefix, then the shape will be defined by the svg file specified in the skin file. For example if the shape is customFoo then the skin file should have a .AFDVTShapeCustomFoo:alias selector defined or the Thematic Map specific af|dvt-thematicMap::shape-customFoo defined which has the -tr-path property pointing to the svg file.

Parameters:

shape - the shape of the marker

getShapePath

public final java.lang.String getShapePath()

Gets the path to the svg file to use as a custom shape

Returns:

path to custom svg file

setShapePath

public final void setShapePath(java.lang.String shapePath)

Specifies the path to the svg file to use as a custom shape

Parameters:

shapePath - path to custom svg file

getScaleX

public final double getScaleX()

Gets the horizontal scale factor for this marker. This determines how much to scale the marker from its default size.

Returns:

horizontal scale factor

setScaleX

public final void setScaleX(double scaleX)

Sets the horizontal scale factor for this marker. This determines how much to scale the marker from its default size.

Parameters:

scaleX - horizontal scale factor

getScaleY

public final double getScaleY()

Gets the vertical scale factor for this marker. This determines how much to scale the marker from its default size.

Returns:

vertical scale factor

setScaleY

public final void setScaleY(double scaleY)

Gets the vertical scale factor for this marker. This determines how much to scale the marker from its default size.

Parameters:

scaleY - vertical scale factor

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 marker'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 marker's tooltip.

Parameters:

shortDesc - short description of this component

getFillColor

public final java.awt.Color getFillColor()

Gets the fill color of this marker. Valid values are RGB hexadecimal

Returns:

fill color of this marker

setFillColor

public final void setFillColor(java.awt.Color fillColor)

Sets the fill color of this marker. Valid values are RGB hexadecimal

Parameters:

fillColor - fill color of this marker

getFillPattern

public final java.lang.String getFillPattern()

Gets the built-in pattern used to fill this marker. 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 marker

setFillPattern

public final void setFillPattern(java.lang.String pattern)

Sets the built-in pattern used to fill this marker. 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 marker

getOpacity

public final double getOpacity()

Gets the opacity of the fill color of the marker. Valid values are from 0.0 - 1.0, where 0.0 is transparent and 1.0 is opaque.

Returns:

opacity of the marker

setOpacity

public final void setOpacity(double opacity)

Specifies the opacity of the fill color of the marker. Valid values are from 0.0 - 1.0, where 0.0 is transparent and 1.0 is opaque.

Parameters:

opacity - opacity of the marker

getGradientEffect

public final java.lang.String getGradientEffect()

Gets the gradient effect that should be used for this marker. Valid values are: "auto" - (default) Sets a gradient on the marker "none" - Do not use gradients on the marker. This causes markers to appear flat.

Returns:

gradient effect for this marker

setGradientEffect

public final void setGradientEffect(java.lang.String gradientEffect)

Specifies the gradient effect that should be used for this marker. Valid values are: "auto" - (default) Sets a gradient on the marker "none" - Do not use gradients on the marker. This causes markers to appear flat.

Parameters:

gradientEffect - gradient effect for this marker

getLabelDisplay

public final java.lang.String getLabelDisplay()

Gets the label display behavior for this marker. Valid values are: "on" - Display the label provided in the value attribute "off" - (default) Do not display the label provided in the value attribute

Returns:

label display behavior for this marker

setLabelDisplay

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

Sets the label display behavior for this marker. Valid values are: "on" - Display the label provided in the value attribute "off" - (default) Do not display the label provided in the value attribute

Parameters:

labelDisplay - label display behavior for this marker

getLabelPosition

public final java.lang.String getLabelPosition()

Gets the position relative to the marker that the specified value label should be displayed at. Valid values are: "top" - Display the label on top of the marker "bottom" - Display the label below the marker "center" - (default) Display the label on the center of the marker

Returns:

position of the marker's label

setLabelPosition

public final void setLabelPosition(java.lang.String labelPosition)

Sets the position relative to the marker that the specified value label should be displayed at. Valid values are: "top" - Display the label on top of the marker "bottom" - Display the label below the marker "center" - (default) Display the label on the center of the marker

Parameters:

labelPosition - position of the marker's label

getLabelStyle

public final java.lang.String getLabelStyle()

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

Returns:

font style for labels associated with this marker

setLabelStyle

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

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

Parameters:

labelStyle - font style for labels associated with this marker

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

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

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