Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 1 (11.1.1.7.0)

E12063-08

oracle.adf.view.faces.bi.component.graph
Class UISparkChart

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.graph.UISparkChart
All Implemented Interfaces:
javax.faces.component.StateHolder
Direct Known Subclasses:
RichSparkChart

public class UISparkChart
extends org.apache.myfaces.trinidad.component.UIXComponentBase

Spark chart component.

Since:
release specific (what release of product did this appear in)

Field Summary
static org.apache.myfaces.trinidad.bean.PropertyKey AXIS_SCALED_FROM_BASELINE_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey CLICK_ACTION_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey CLICK_LISTENER_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey COLOR_KEY
           
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_DELIVERY_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey FIRST_MARKER_COLOR_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey HIGH_MARKER_COLOR_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey LAST_MARKER_COLOR_KEY
           
protected static java.lang.String LOGGERCLASS
           
static org.apache.myfaces.trinidad.bean.PropertyKey LOW_MARKER_COLOR_KEY
           
static java.lang.String MARKER_SCALING_AUTO
           
static java.lang.String MARKER_SCALING_OFF
           
static org.apache.myfaces.trinidad.bean.PropertyKey MARKERS_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey NO_DATA_ERROR_TEXT_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey REFERENCE_OBJECT_SET_KEY
           
static java.lang.String RENDERER_TYPE
           
static org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey SUB_TYPE_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey THRESHOLD_SET_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey TOOLTIP_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
bindings
 
Constructor Summary
UISparkChart()
           
UISparkChart(java.lang.String rendererType)
           
 
Method Summary
 void addClickListener(ClickListener listener)
           
 java.lang.String getAxisScaledFromBaseline()
          Returns a String describing whether the axis is scaled to include the baseline value of zero.
protected  org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
           
 javax.el.MethodExpression getClickAction()
           
 javax.el.MethodExpression getClickListener()
           
 java.lang.String getColor()
          gets the color.
 java.lang.String getContentDelivery()
          Retrieves whether the content of the imageView is delivered immediately or lazily.
 java.lang.String getFamily()
           
 java.lang.String getFirstMarkerColor()
          gets the first marker color.
 java.lang.String getHighMarkerColor()
          gets the high marker color.
 java.lang.String getInlineStyle()
          Gets Specifies CSS styles to use for this component.
 java.lang.String getLastMarkerColor()
          gets the last marker color.
 java.lang.String getLowMarkerColor()
          gets the low marker color.
 java.lang.String getMarkers()
          gets the markers property
 java.lang.String getNoDataErrorText()
          Get the error text to display when graph has no data.
 java.lang.String[] getPartialTriggers()
           
 ReferenceObjectSet getReferenceObjectSet()
           
 java.lang.String getRendererType()
           
 java.lang.String getShortDesc()
          Get the short description text for this view.This text is useful when the view is in screen reader mode The default value is null.
 java.lang.String getStyleClass()
          Retrieves the CSS style class to use for this component.
 java.lang.String getSubType()
           
 ThresholdSet getThresholdSet()
           
 java.lang.String getTooltip()
          Returns the tooltip to display on this spark chart.
The default value is null.
 void setAxisScaledFromBaseline(java.lang.String value)
          Specifies whether the axis should be scaled to include the baseline value of zero.
 void setClickAction(javax.el.MethodExpression clickAction)
           
 void setClickListener(javax.el.MethodExpression clickListener)
           
 void setColor(java.lang.String color)
           
 void setContentDelivery(java.lang.String delivery)
          Specifies whether the content of the imageView is delivered immediately or lazily.
 void setFirstMarkerColor(java.lang.String firstMarkerColor)
          sets the first marker color.
 void setHighMarkerColor(java.lang.String highMarkerColor)
          sets the high marker color.
 void setInlineStyle(java.lang.String inlineStyle)
          Sets Specifies CSS styles to use for this component.
 void setLastMarkerColor(java.lang.String lastMarkerColor)
          sets the last marker color.
 void setLowMarkerColor(java.lang.String lowMarkerColor)
          sets the low marker color.
 void setMarkers(java.lang.String markers)
          sets the markers property
 void setNoDataErrorText(java.lang.String text)
          Set the error text to display when graph has no data.
 void setPartialTriggers(java.lang.String[] ids)
           
 void setReferenceObjectSet(ReferenceObjectSet refObjSet)
           
 void setShortDesc(java.lang.String text)
          Set the short description text for this view.
 void setStyleClass(java.lang.String styleClass)
          Sets a CSS style class to use for this component.
 void setSubType(java.lang.String subType)
           
 void setThresholdSet(ThresholdSet thresholdSet)
           
 void setTooltip(java.lang.String text)
          Specifies the tooltip to display on this spark chart.
The default value is null.
 
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcast, 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

CONTENT_DELIVERY_KEY

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

INLINE_STYLE_KEY

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

PARTIAL_TRIGGERS_KEY

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

SHORT_DESC_KEY

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

STYLE_CLASS_KEY

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

SUB_TYPE_KEY

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

AXIS_SCALED_FROM_BASELINE_KEY

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

NO_DATA_ERROR_TEXT_KEY

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

TOOLTIP_KEY

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

COLOR_KEY

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

FIRST_MARKER_COLOR_KEY

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

LAST_MARKER_COLOR_KEY

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

HIGH_MARKER_COLOR_KEY

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

LOW_MARKER_COLOR_KEY

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

MARKERS_KEY

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

CLICK_LISTENER_KEY

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

CLICK_ACTION_KEY

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

REFERENCE_OBJECT_SET_KEY

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

THRESHOLD_SET_KEY

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

MARKER_SCALING_AUTO

public static final java.lang.String MARKER_SCALING_AUTO
See Also:
Constant Field Values

MARKER_SCALING_OFF

public static final java.lang.String MARKER_SCALING_OFF
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

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE
See Also:
Constant Field Values

LOGGERCLASS

protected static java.lang.String LOGGERCLASS
Constructor Detail

UISparkChart

public UISparkChart()

UISparkChart

public UISparkChart(java.lang.String rendererType)
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

setContentDelivery

public void setContentDelivery(java.lang.String delivery)
Specifies whether the content of the imageView is delivered immediately or lazily. Valid values are "lazy" or "immediate". If "lazy", then imageView's content is fetched after the imageView is sent to the browser. If "immediate", then the imageView content is immediately sent to the browser. Supported in ADF Faces only. The default value is "lazy".

Parameters:
delivery - A constant that represents the contentDelivery setting.

getContentDelivery

public java.lang.String getContentDelivery()
Retrieves whether the content of the imageView is delivered immediately or lazily. Valid values are "lazy" or "immediate". If "lazy", then imageView's content is fetched after the imageView is sent to the browser. If "immediate", then the imageView content is immediately sent to the browser. If "whenAvailable", then "immediate" content delivery is used if the data is already available; otherwise "lazy" content delivery is used.

Returns:
imageView's content delivery mode

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)
Sets Specifies CSS styles to use for this component. This is intended for basic style changes; you should use the skinning mechanism if you require any complex style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Many components are composed of several DOM elements which may have their own styles applied to them. Defining a style in the inlineStyle may not always give you what you want. For example, if one of the inner DOM elements for this component has a background color specified for it in the skin, setting a background color in the inlineStyle may not provide any visible change (at least for where that inner DOM element exists) because the inner DOM element's background color will win (since that DOM element is essentially layered on top of the root element).

Parameters:
inlineStyle - the new inlineStyle value

getInlineStyle

public final java.lang.String getInlineStyle()
Gets Specifies CSS styles to use for this component. This is intended for basic style changes; you should use the skinning mechanism if you require any complex style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Many components are composed of several DOM elements which may have their own styles applied to them. Defining a style in the inlineStyle may not always give you what you want. For example, if one of the inner DOM elements for this component has a background color specified for it in the skin, setting a background color in the inlineStyle may not provide any visible change (at least for where that inner DOM element exists) because the inner DOM element's background color will win (since that DOM element is essentially layered on top of the root element). *

Returns:
the inlineStyle value

setPartialTriggers

public void setPartialTriggers(java.lang.String[] ids)

getPartialTriggers

public java.lang.String[] getPartialTriggers()

setShortDesc

public void setShortDesc(java.lang.String text)
Set the short description text for this view. This text is useful when the view is in screen reader mode. The default value is null.

Parameters:
text - short description

getShortDesc

public java.lang.String getShortDesc()
Get the short description text for this view.This text is useful when the view is in screen reader mode The default value is null.

Returns:
short description text

getStyleClass

public java.lang.String getStyleClass()
Retrieves the CSS style class to use for this component.

Returns:
imageView's style class

setStyleClass

public void setStyleClass(java.lang.String styleClass)
Sets a CSS style class to use for this component.

Parameters:
styleClass - the imageView's style class

getSubType

public java.lang.String getSubType()

setSubType

public void setSubType(java.lang.String subType)

getAxisScaledFromBaseline

public java.lang.String getAxisScaledFromBaseline()
Returns a String describing whether the axis is scaled to include the baseline value of zero. Valid values are:
on - indicates the axis should be scaled to include the baseline (default)
off - indicates the axis should not be scaled to include the baseline. This will scale the axis according to the minimum and maximum values of the data.

Returns:

setAxisScaledFromBaseline

public void setAxisScaledFromBaseline(java.lang.String value)
Specifies whether the axis should be scaled to include the baseline value of zero. Valid values are:
on - indicates the axis should be scaled to include the baseline (default)
off - indicates the axis should not be scaled to include the baseline. This will scale the axis according to the minimum and maximum values of the data.

Parameters:
value -

getTooltip

public java.lang.String getTooltip()
Returns the tooltip to display on this spark chart.
The default value is null. When the value is null or an empty string, graph will not display a tooltip

Returns:
the tooltip text

setTooltip

public void setTooltip(java.lang.String text)
Specifies the tooltip to display on this spark chart.
The default value is null. When the value is null or an empty string, graph will not display a tooltip

Parameters:
text - the tooltip text

setNoDataErrorText

public void setNoDataErrorText(java.lang.String text)
Set the error text to display when graph has no data. The default value is null. When the value is null or an empty string, graph will display its default translated no data message, "No Data Currently Available".

Parameters:
text - error text

getNoDataErrorText

public java.lang.String getNoDataErrorText()
Get the error text to display when graph has no data. The default value is null. When the value is null or an empty string, graph will display its default translated no data message, "No Data Currently Available".

Returns:
error text

addClickListener

public void addClickListener(ClickListener listener)

getClickListener

public final javax.el.MethodExpression getClickListener()

setClickListener

public final void setClickListener(javax.el.MethodExpression clickListener)

getClickAction

public final javax.el.MethodExpression getClickAction()

setClickAction

public final void setClickAction(javax.el.MethodExpression clickAction)

getReferenceObjectSet

public ReferenceObjectSet getReferenceObjectSet()

setReferenceObjectSet

public void setReferenceObjectSet(ReferenceObjectSet refObjSet)

getThresholdSet

public ThresholdSet getThresholdSet()

setThresholdSet

public void setThresholdSet(ThresholdSet thresholdSet)

setHighMarkerColor

public void setHighMarkerColor(java.lang.String highMarkerColor)
sets the high marker color.


getHighMarkerColor

public java.lang.String getHighMarkerColor()
gets the high marker color.


getFirstMarkerColor

public java.lang.String getFirstMarkerColor()
gets the first marker color.


setFirstMarkerColor

public void setFirstMarkerColor(java.lang.String firstMarkerColor)
sets the first marker color.


getLastMarkerColor

public java.lang.String getLastMarkerColor()
gets the last marker color.


setLastMarkerColor

public void setLastMarkerColor(java.lang.String lastMarkerColor)
sets the last marker color.


getLowMarkerColor

public java.lang.String getLowMarkerColor()
gets the low marker color.


setLowMarkerColor

public void setLowMarkerColor(java.lang.String lowMarkerColor)
sets the low marker color.


getMarkers

public java.lang.String getMarkers()
gets the markers property


setMarkers

public void setMarkers(java.lang.String markers)
sets the markers property


getColor

public java.lang.String getColor()
gets the color.


setColor

public void setColor(java.lang.String color)

Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 1 (11.1.1.7.0)

E12063-08

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