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.imageView
Class UIImageView

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.BIComponentBase
                  extended by oracle.adf.view.faces.bi.component.UIViewComponent
                      extended by oracle.adf.view.faces.bi.component.dataView.UIDataView
                          extended by oracle.adf.view.faces.bi.component.imageView.UIImageView

All Implemented Interfaces:
java.util.EventListener, javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder
Direct Known Subclasses:
CoreGauge, CoreGraph

public abstract class UIImageView
extends UIDataView
implements javax.faces.component.ActionSource
Since:
11.0
For internal use only. Application developers should not use this

Field Summary
static org.apache.myfaces.trinidad.bean.PropertyKey ACTIVEDATA_PROPERTIES_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey ANIMATION_DOWN_COLOR_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey ANIMATION_DURATION_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey ANIMATION_INDICATORS_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey ANIMATION_TYPE_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey ANIMATION_UP_COLOR_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey ATTRIBUTE_FORMATS_KEY
           
static java.lang.String CHART_SWF_PATH
           
static org.apache.myfaces.trinidad.bean.PropertyKey CHART_SWF_PATH_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey CLICK_ACTION_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey CLICK_LISTENER_KEY
           
static java.lang.String CONTENT_DELIVERY
           
static org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_DELIVERY_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
           
static int DISPOSITION_FRAGMENT
           
static int DISPOSITION_STANDALONE
           
static java.lang.String DR_DYNAMIC
           
static java.lang.String DR_FIXED
           
static java.lang.String DYNAMIC_RESIZE
           
static org.apache.myfaces.trinidad.bean.PropertyKey DYNAMIC_RESIZE_KEY
           
static java.lang.String FLASH_CHART_SWF_NAME
           
static int FLASH_DEFAULT_FONT_LOADING_ALL
          Deprecated. FlashDefaultFontLoading: All. Default fonts will be loaded in FLASH from the middle tier.
static org.apache.myfaces.trinidad.bean.PropertyKey FLASH_DEFAULT_FONT_LOADING_KEY
          Deprecated.  
static int FLASH_DEFAULT_FONT_LOADING_NONE
          Deprecated. FlashDefaultFontLoading: None. Default fonts will not be loaded in FLASH from the middle tier.
static java.lang.String FLASH_IS_ADS_TWO
           
static org.apache.myfaces.trinidad.bean.PropertyKey FLASH_IS_ADS_TWO_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey FONT_URL_MAP_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey IMAGE_FORMAT_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey IMAGE_HEIGHT_KEY
          Deprecated. use INLINE_STYLE_KEY instead
static org.apache.myfaces.trinidad.bean.PropertyKey IMAGE_SOURCE_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey IMAGE_WIDTH_KEY
          Deprecated. use INLINE_STYLE_KEY instead
static org.apache.myfaces.trinidad.bean.PropertyKey IN_POPUP_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey INIT_EFFECTS_KEY
           
static java.lang.String INLINE_STYLE
           
static org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey OTHER_PROPERTIES_KEY
          Deprecated. the UIComponent APIs should be used instead.
static java.lang.Object PIVOT_ACTION_TYPE
           
static org.apache.myfaces.trinidad.bean.PropertyKey RENDERMAP_KEY
           
static java.lang.String ROWS_AS_SERIES
           
static org.apache.myfaces.trinidad.bean.PropertyKey ROWS_AS_SERIES_KEY
           
static java.lang.String SHAPE_ATTRIBUTES_SET
           
static org.apache.myfaces.trinidad.bean.PropertyKey SHAPE_ATTRIBUTES_SET_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey SHAPE_ATTRS_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
           
static int SVG_DISPOSITION_FRAGMENT
          Deprecated. use DISPOSITION_FRAGMENT instead SvgDisposition: fragment. The SVG Graph will be used as a piece of a larger component.
static org.apache.myfaces.trinidad.bean.PropertyKey SVG_DISPOSITION_KEY
           
static int SVG_DISPOSITION_STANDALONE
          Deprecated. use DISPOSITION_STANDALONE instead SvgDisposition: standalone. The SVG Graph will be used standalone, as a component.
static int SVG_FONT_EMBEDDING_ALL
          SVGFontEmbedding: All.
static org.apache.myfaces.trinidad.bean.PropertyKey SVG_FONT_EMBEDDING_KEY
           
static int SVG_FONT_EMBEDDING_NONE
          SVGFontEmbedding: None.
static org.apache.myfaces.trinidad.bean.PropertyKey SVG_OUTPUT_STREAM_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey SVG_PARENT_FORM_CLIENT_ID_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey SVG_WRITER_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey TABULAR_DATA_KEY
           
static org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
           
static org.apache.myfaces.trinidad.bean.PropertyKey VISUAL_EFFECTS_KEY
           

 

Fields inherited from class oracle.adf.view.faces.bi.component.dataView.UIDataView
CLICK_EVENT_TYPE, COMPONENT_FAMILY, COMPONENT_TYPE, DRILL_ACTION_KEY, DRILL_ACTION_TYPE, DRILL_REQUESTED_LISTENER_KEY, DRILL_REQUESTING_LISTENER_KEY, DRILLING_ENABLED_KEY, IMAGE_FORMAT_AUTO, IMAGE_FORMAT_FLASH, IMAGE_FORMAT_PNG, IMAGE_FORMAT_PNG_STAMPED, IMAGE_FORMAT_SVG, immediate, lazy, logger, LOGGERCLASS, m_locale, PARTIAL_SUBMIT_KEY, PARTIAL_TRIGGERS_KEY, TOKEN_SUBSTITUTION_KEY, 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

 

Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR

 

Constructor Summary
UIImageView()
           
UIImageView(java.lang.String rendererType)
           

 

Method Summary
 void addClickListener(ClickListener listener)
           
 void broadcast(javax.faces.event.FacesEvent event)
          Broadcast an event to a MethodBinding.
abstract  java.lang.String convertCompIdToFacetName(int id)
          Subclasses must implement this method.
 javax.el.MethodExpression getActionExpression()
           
 ActiveDataProperties getActiveDataProperties()
           
 java.awt.Color getAnimationDownColor()
          Returns the color used to indicate that a data value has decreased.
 int getAnimationDuration()
          Returns the animation duration in milliseconds Supported in ADF Faces only.
 int getAnimationIndicators()
          Returns which data change indicators should be shown.
 int getAnimationOnDataChange()
          Returns the type of data change animations to apply.
 int getAnimationOnDisplay()
          Returns the type of initial rendering effect to apply.
 java.awt.Color getAnimationUpColor()
          Returns the color used to indicate that a data value has increased.
 java.util.List<AttributeFormat> getAttributeFormats()
          Get the attribute format components for this view.
protected  org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
           
 javax.el.MethodExpression getClickAction()
           
 javax.el.MethodExpression getClickListener()
           
 ClickListener[] getClickListeners()
           
protected  ComponentHandle getComponentHandle()
          Convenience method for ComponentHandle subclasses to get instance of ComponentHandle.
 java.lang.String getContentDelivery()
          Retrieves whether the content of the imageView is delivered immediately or lazily.
 java.lang.String getCustomizationId()
          Deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
 DataUpdateCache getDataCache()
          Deprecated. this method should not be used by applications
 java.lang.String getDataUpdateHint()
          Deprecated. this method should not be used by applications
 int getDisposition()
           
 java.lang.String getDynamicResize()
          This property is used to support dynamic resizing of the graph and gauge.
 int getFlashDefaultFontLoading()
          Deprecated. Determine whether default fonts are loaded in FLASH from the middle tier. Valid values are defined in this class: FLASH_DEFAULT_FONT_LOADING_ALL and FLASH_DEFAULT_FONT_LOADING_NONE. The default value is FLASH_DEFAULT_FONT_LOADING_ALL. Supported in ADF Faces only.
static java.lang.String getFlashRenderingEngineSwfPath(javax.faces.context.FacesContext context)
           
 java.lang.String getFlashVarsString(java.lang.String clientId)
           
 java.util.Map getFontURLMap()
          Get a Map containing fontNames and URLs to their font files.
 int getImageFormat()
          Retrieves the format of image to produce- PNG, SVG or AUTO.
 int getImageHeight()
          Deprecated. use getInlineStyle instead
 java.lang.String getImageSource()
          Retrieves a string providing a URI that will be used as a value for SRC attribute of the IMG HTML tag
 ImageView getImageView()
          Convenience method to retrieve the ImageView instance of this image view.
 int getImageWidth()
          Deprecated. use getInlineStyle instead
 java.lang.String getInlineStyle()
          Gets Specifies CSS styles to use for this component.
 java.lang.String getOtherProperties()
          Deprecated. UIComponent APIs should be used instead.
 java.awt.Rectangle getPopupHelperBounds()
          Returns the bounds used to help position a popup within the imageview region.
 boolean getRendersChildren()
           
protected  ShapeAttributes getShapeAttributes()
          Convenience method for UIDataview subclasses to get instance of ShapeAttributes.
 ShapeAttributesCallback getShapeAttributesCallback()
          Retrieves the ShapeAttributesCallback that this CoreGraph.
 ShapeAttributesSet getShapeAttributesSet()
           
 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.
 int getSvgDisposition()
          Deprecated. use getDisposition instead
 int getSvgFontEmbedding()
          Determine whether fonts are embedded in SVG.
 java.io.OutputStream getSvgOutputStream()
           
 java.lang.String getSvgParentFormClientId()
           
 java.util.List getSvgScriptIdList()
           
 java.io.Writer getSvgWriter()
           
 java.util.List getTabularData()
           
 int getVisualEffects()
          Returns the type or types of visualEffect to apply.
 boolean isDrillingEnabled()
          Indicates whether drilling is allowed in this view.
 boolean isRenderImagemap()
          Retrieves whether image map should be generated.
 boolean isSvgEncodingScriptTag()
           
 boolean isTransferProperties()
           
 boolean isUpdated()
           
 void removeClickListener(ClickListener listener)
           
 void setActiveDataProperties(ActiveDataProperties activeDataProperties)
           
 void setAnimationDownColor(java.awt.Color clr)
          Specifies the color used to indicate that a data value has decreased.
 void setAnimationDuration(int duration)
          Specifies the animation duration in milliseconds Supported in ADF Faces only.
 void setAnimationIndicators(int type)
          Specifies which data change indicators should be shown.
 void setAnimationIndicators(java.lang.String type)
          Specifies which data change indicators should be shown.
 void setAnimationOnDataChange(int type)
          Specifies the type of data change animations to apply.
 void setAnimationOnDataChange(java.lang.String type)
          Specifies the type of data change animation to apply.
 void setAnimationOnDisplay(int type)
          Specifies the type of initial rendering effect to apply.
 void setAnimationOnDisplay(java.lang.String type)
          Specifies the type of data change animation to apply.
 void setAnimationUpColor(java.awt.Color clr)
          Specifies the color used to indicate that a data value has increased.
 void setAttributeFormats(java.util.List<AttributeFormat> attributeFormats)
          Set the list of AttributeFormat components for this view.
 void setClickAction(javax.el.MethodExpression clickAction)
           
 void setClickListener(javax.el.MethodExpression clickListener)
           
protected  void setComponentHandle(ComponentHandle handle)
          Convenience method for ComponentHandle subclasses to set instance of ComponentHandle.
 void setContentDelivery(int delivery)
          Specifies whether content is sent with the page load or after the page load.
 void setContentDelivery(java.lang.String delivery)
          Specifies whether the content of the imageView is delivered immediately or lazily.
 void setCustomizationId(java.lang.String customizationId)
          Deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
 void setDataCache(DataUpdateCache cache)
          Deprecated. this method should not be used by applications
 void setDataUpdateHint(java.lang.String hint)
          Deprecated. this method should not be used by applications
 void setDisposition(int disposition)
           
 void setDrillingEnabled(boolean b)
          Specifies whether drilling is allowed in this view.
 void setDynamicResize(java.lang.String dynamicResize)
          This property is used to support dynamic resizing of the graph and gauge.
 void setFlashDefaultFontLoading(int loading)
          Deprecated. Set whether default fonts are loaded in FLASH from the middle tier. Valid values are defined in this class: FLASH_DEFAULT_FONT_LOADING_ALL and FLASH_DEFAULT_FONT_LOADING_NONE. The default value is FLASH_DEFAULT_FONT_LOADING_ALL. Supported in ADF Faces only.
 void setFlashDefaultFontLoading(java.lang.String loading)
          Deprecated. Set whether default fonts are loaded in FLASH from the middle tier. Valid values are defined in this class: FLASH_DEFAULT_FONT_LOADING_ALL and FLASH_DEFAULT_FONT_LOADING_NONE. The default value is FLASH_DEFAULT_FONT_LOADING_ALL. Supported in ADF Faces only.
 void setFontURLMap(java.util.Map urlMap)
          Set a Map containing fontNames and URLs to their font files.
 void setImageFormat(int format)
          Specifies the format of image to produce- PNG, SVG or AUTO.
 void setImageFormat(java.lang.String format)
          Specifies the format of image to produce- PNG, SVG or AUTO.
 void setImageHeight(int height)
          Deprecated. use setInlineStyle instead
 void setImageSource(java.lang.String source)
          Specifies a URI that will be used as a value for SRC attribute of the IMG HTML tag .
 void setImageView(ImageView cmnIV)
          Sets the given instance of ImageView for this image-based view.
 void setImageWidth(int width)
          Deprecated. use setInlineStyle instead
 void setInlineStyle(java.lang.String inlineStyle)
          Sets Specifies CSS styles to use for this component.
 void setOtherProperties(java.lang.String xml)
          Deprecated. UIComponent APIs should be used instead.
 void setPopupHelperBounds(java.awt.Rectangle bounds)
          Sets the bounds used to help in positioning a popup within the imageview region.
protected  void setProperty(org.apache.myfaces.trinidad.bean.PropertyKey key, java.lang.Object value)
           
 void setRenderImagemap(boolean render)
          Specifies whether an image map should be rendered.
protected  void setShapeAttributes(ShapeAttributes attrs)
          Convenience method for UIDataview subclasses to set instance of ShapeAttributes.
 void setShapeAttributesCallback(ShapeAttributesCallback callback)
          Specifies the ShapeAttributesCallback that will provide ShapeAttributes such as onClick, onFocus etc for this CoreGraph.
 void setShapeAttributesSet(ShapeAttributesSet shapeAttributesSet)
           
 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 setSvgDisposition(int disposition)
          Deprecated. use setDisposition instead
 void setSvgEncodingScriptTag(boolean bEncode)
           
 void setSvgFontEmbedding(int embedding)
          Set whether fonts are embedded in SVG.
 void setSvgFontEmbedding(java.lang.String embedding)
          Set whether fonts are embedded in SVG.
 void setSvgOutputStream(java.io.OutputStream stream)
           
 void setSvgParentFormClientId(java.lang.String id)
           
 void setSvgWriter(java.io.Writer writer)
           
 void setTabularData(java.util.List tableRows)
          Specifies data for the Graph, from a table of data.
 void setUpdated(boolean updated)
           
 void setVisualEffects(int type)
          Specifies the type or types of visual effects to apply.
 void setVisualEffects(java.lang.String type)
          Specifies the type or types of visualEffect to apply.
 void transferProperties()
          Configures the ImageView with the properties from the UIImageView.

 

Methods inherited from class oracle.adf.view.faces.bi.component.dataView.UIDataView
_getLayerLabel, _getMemberLabel, _getMemberLabel, addActionListener, addDrillListener, clearWaitDataForAllRows, drill, fireEventToAppListener, getAction, getActionListener, getActionListeners, getActionType, getConverter, getDataModel, getDefaultDataModel, getDescription, getDrillAction, getDrillListeners, getDrillRequestedListener, getDrillRequestingListener, getFacet, getFamily, getLayerLabel, getLayerMetadataLabelType, getLayerMetadataLabelType, getLocalValue, getMemberLabel, getMemberLabel, getMemberMetadataLabelType, getMemberMetadataLabelType, getPartialTriggers, getSuppressFontName, getTokenSubstitution, getValue, getWaitDataForRow, getXMLAsString, getZoomFactor, initialize, isEnabled, isImmediate, isLayerMetadataLabelTypeSupported, isMemberMetadataLabelTypeSupported, isPartialSubmit, queueEvent, removeActionListener, removeDrillListener, setAction, setActionExpression, setActionListener, setActionType, setConverter, setDataModel, setDescription, setDrillAction, setDrillRequestedListener, setDrillRequestingListener, setEnabled, setImmediate, setLayerMetadataLabelType, setLayerMetadataLabelType, setMemberMetadataLabelType, setMemberMetadataLabelType, setPartialSubmit, setPartialTriggers, setSuppressFontName, setTokenSubstitution, setValue, setWaitDataForRow, setXMLAsString, specifyPersistableAttributes

 

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, getRendererType, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeAttributeChangeListener, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, 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

 

Methods inherited from interface javax.faces.component.ActionSource
addActionListener, getAction, getActionListener, getActionListeners, isImmediate, removeActionListener, setAction, setActionListener, setImmediate

 

Field Detail

SVG_FONT_EMBEDDING_NONE

public static final int SVG_FONT_EMBEDDING_NONE
SVGFontEmbedding: None. No fonts will be embedded in SVG.
See Also:
Constant Field Values

SVG_FONT_EMBEDDING_ALL

public static final int SVG_FONT_EMBEDDING_ALL
SVGFontEmbedding: All. Fonts for all text shown in Graph will be embedded in SVG.
See Also:
Constant Field Values

FLASH_DEFAULT_FONT_LOADING_NONE

@Deprecated
public static final int FLASH_DEFAULT_FONT_LOADING_NONE
Deprecated. FlashDefaultFontLoading: None. Default fonts will not be loaded in FLASH from the middle tier.
Deprecated attribute. Embedded or device fonts will be selected automatically based on need.
See Also:
Constant Field Values

FLASH_DEFAULT_FONT_LOADING_ALL

@Deprecated
public static final int FLASH_DEFAULT_FONT_LOADING_ALL
Deprecated. FlashDefaultFontLoading: All. Default fonts will be loaded in FLASH from the middle tier.
Deprecated attribute. Embedded or device fonts will be selected automatically based on need.
See Also:
Constant Field Values

SVG_DISPOSITION_STANDALONE

@Deprecated
public static final int SVG_DISPOSITION_STANDALONE
Deprecated. use DISPOSITION_STANDALONE instead SvgDisposition: standalone. The SVG Graph will be used standalone, as a component.
See Also:
Constant Field Values
For internal use only. Application developers should not use this

SVG_DISPOSITION_FRAGMENT

@Deprecated
public static final int SVG_DISPOSITION_FRAGMENT
Deprecated. use DISPOSITION_FRAGMENT instead SvgDisposition: fragment. The SVG Graph will be used as a piece of a larger component.
See Also:
Constant Field Values
For internal use only. Application developers should not use this

DISPOSITION_STANDALONE

public static final int DISPOSITION_STANDALONE
See Also:
Constant Field Values
For internal use only. Application developers should not use this
Disposition: standalone. The Graph will be used standalone, as a component.

DISPOSITION_FRAGMENT

public static final int DISPOSITION_FRAGMENT
See Also:
Constant Field Values
For internal use only. Application developers should not use this
Disposition: fragment. The Graph will be used as a piece of a larger component.

TYPE

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

IMAGE_SOURCE_KEY

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

RENDERMAP_KEY

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

IMAGE_WIDTH_KEY

@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey IMAGE_WIDTH_KEY
Deprecated. use INLINE_STYLE_KEY instead

IMAGE_HEIGHT_KEY

@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey IMAGE_HEIGHT_KEY
Deprecated. use INLINE_STYLE_KEY instead

IMAGE_FORMAT_KEY

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

SVG_FONT_EMBEDDING_KEY

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

FLASH_DEFAULT_FONT_LOADING_KEY

@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey FLASH_DEFAULT_FONT_LOADING_KEY
Deprecated. 
Deprecated attribute. Embedded or device fonts will be selected automatically based on need.

FONT_URL_MAP_KEY

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

SVG_OUTPUT_STREAM_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SVG_OUTPUT_STREAM_KEY
For internal use only. Application developers should not use this

SVG_WRITER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SVG_WRITER_KEY
For internal use only. Application developers should not use this

SVG_PARENT_FORM_CLIENT_ID_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SVG_PARENT_FORM_CLIENT_ID_KEY
For internal use only. Application developers should not use this

SVG_DISPOSITION_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SVG_DISPOSITION_KEY
For internal use only. Application developers should not use this

OTHER_PROPERTIES_KEY

@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey OTHER_PROPERTIES_KEY
Deprecated. the UIComponent APIs should be used instead.

TABULAR_DATA_KEY

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

SHAPE_ATTRS_KEY

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

SHAPE_ATTRIBUTES_SET_KEY

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

FLASH_CHART_SWF_NAME

public static final java.lang.String FLASH_CHART_SWF_NAME
See Also:
Constant Field Values
For internal use only. Application developers should not use this

FLASH_IS_ADS_TWO

public static final java.lang.String FLASH_IS_ADS_TWO
See Also:
Constant Field Values
For internal use only. Application developers should not use this

CHART_SWF_PATH

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

ROWS_AS_SERIES

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

CONTENT_DELIVERY

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

INLINE_STYLE

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

DYNAMIC_RESIZE

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

CHART_SWF_PATH_KEY

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

FLASH_IS_ADS_TWO_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey FLASH_IS_ADS_TWO_KEY
For internal use only. Application developers should not use this

ACTIVEDATA_PROPERTIES_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ACTIVEDATA_PROPERTIES_KEY
For internal use only. Application developers should not use this

ROWS_AS_SERIES_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ROWS_AS_SERIES_KEY
For internal use only. Application developers should not use this

CONTENT_DELIVERY_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_DELIVERY_KEY
For internal use only. Application developers should not use this

INLINE_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
For internal use only. Application developers should not use this

DYNAMIC_RESIZE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DYNAMIC_RESIZE_KEY
For internal use only. Application developers should not use this

IN_POPUP_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey IN_POPUP_KEY
For internal use only. Application developers should not use this

SHORT_DESC_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
For internal use only. Application developers should not use this

STYLE_CLASS_KEY

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

CUSTOMIZATION_ID_KEY

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

ANIMATION_TYPE_KEY

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

ANIMATION_INDICATORS_KEY

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

ANIMATION_UP_COLOR_KEY

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

ANIMATION_DOWN_COLOR_KEY

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

ANIMATION_DURATION_KEY

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

INIT_EFFECTS_KEY

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

VISUAL_EFFECTS_KEY

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

ATTRIBUTE_FORMATS_KEY

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

PIVOT_ACTION_TYPE

public static final java.lang.Object PIVOT_ACTION_TYPE

SHAPE_ATTRIBUTES_SET

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

DR_FIXED

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

DR_DYNAMIC

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

Constructor Detail

UIImageView

public UIImageView()

UIImageView

public UIImageView(java.lang.String rendererType)

Method Detail

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException
Description copied from class: UIDataView
Broadcast an event to a MethodBinding.
Overrides:
broadcast in class UIDataView
Throws:
javax.faces.event.AbortProcessingException

addClickListener

public void addClickListener(ClickListener listener)

removeClickListener

public void removeClickListener(ClickListener listener)

getClickListeners

public ClickListener[] getClickListeners()

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)

getActionExpression

public javax.el.MethodExpression getActionExpression()
Specified by:
getActionExpression in interface javax.faces.component.ActionSource2
Overrides:
getActionExpression in class UIDataView
For internal use only. Application developers should not use this

getShapeAttributesCallback

public ShapeAttributesCallback getShapeAttributesCallback()
Retrieves the ShapeAttributesCallback that this CoreGraph.
Returns:
The ShapeAttributesCallback that provides ShapeAttributes such as onClick, onFocus etc. Returns null if no ShapeAttributesCallback has been set.

setShapeAttributesCallback

public void setShapeAttributesCallback(ShapeAttributesCallback callback)
Specifies the ShapeAttributesCallback that will provide ShapeAttributes such as onClick, onFocus etc for this CoreGraph. This callback should be used for specifying ShapeAttributes programmatically. In order to specify ShapeAttributes declaratively, use ShapeAttributesSet.
Parameters:
callback - The ShapeAttributesCallback

setImageView

public final void setImageView(ImageView cmnIV)
Sets the given instance of ImageView for this image-based view.
Parameters:
cmnIV - Instance of ImageView

getImageView

public final ImageView getImageView()
Convenience method to retrieve the ImageView instance of this image view. Before using ImageView APIs that rely on attribute values from this UIImageView, the transferProperties() method should first be called to update the ImageView with the dataModel and attributes from this UIImageView.
Returns:
Instance of ImageView

transferProperties

public void transferProperties()
Configures the ImageView with the properties from the UIImageView. This method makes sure that the data model and all attribute values from this UIImageView are properly reflected in the ImageView. While it is not necessary to call this during the normal ADF Faces rendering cycle, this method should be called before ImageView APIs that rely on UIImageView attribute values.

getSvgScriptIdList

public java.util.List getSvgScriptIdList()
Returns:
list of SVG script node ids
For internal use only. Application developers should not use this
Get the list of SVG script node ids. This method will only return a valid list after the view has been rendered as SVG.

setImageSource

public void setImageSource(java.lang.String source)
Specifies a URI that will be used as a value for SRC attribute of the IMG HTML tag .
Parameters:
source - URI that will be used as a value for SRC attribute of the IMG HTML tag .

getImageSource

public java.lang.String getImageSource()
Retrieves a string providing a URI that will be used as a value for SRC attribute of the IMG HTML tag
Returns:
A String providing a URI that will be used as a value for SRC attribute of the IMG HTML tag

setRenderImagemap

public void setRenderImagemap(boolean render)
Specifies whether an image map should be rendered. If this parameter is not specified, it defaults to true.
Parameters:
render - A flag specifying whether an image map should be rendered If this parameter is not specified, it defaults to true .

isRenderImagemap

public boolean isRenderImagemap()
Retrieves whether image map should be generated.
Returns:
A boolean specifying whether image map should be generated.

setImageWidth

@Deprecated
public void setImageWidth(int width)
Deprecated. use setInlineStyle instead
Specifies a width for this view in pixels.
Parameters:
width - the width of this view in pixels.

getImageWidth

@Deprecated
public int getImageWidth()
Deprecated. use getInlineStyle instead
Retrieves the width for this view in pixels.
Returns:
the width of this view in pixels.

setImageHeight

@Deprecated
public void setImageHeight(int height)
Deprecated. use setInlineStyle instead
Specifies a height for this view in pixels.
Parameters:
height - the height of this view in pixels.

getImageHeight

@Deprecated
public int getImageHeight()
Deprecated. use getInlineStyle instead
Retrieves the height for this view in pixels.
Returns:
the height of this view in pixels.

setDrillingEnabled

public void setDrillingEnabled(boolean b)
Specifies whether drilling is allowed in this view. Drilling is enabled by default.
Overrides:
setDrillingEnabled in class UIDataView
Parameters:
b - true to enable drilling; false to disable drilling.

isDrillingEnabled

public final boolean isDrillingEnabled()
Indicates whether drilling is allowed in this view.
Overrides:
isDrillingEnabled in class UIDataView
Returns:
true if drilling is enabled, false if drilling is disabled.

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

setImageFormat

public void setImageFormat(int format)
Specifies the format of image to produce- PNG, SVG or AUTO. AUTO means generate FLASH if browser supports otherwise PNG. Constants are defined in UIDataView and begin with IMAGE_FOMART_. Supported in ADF Faces only.
Parameters:
format - A constant that represents the image format.

setImageFormat

public void setImageFormat(java.lang.String format)
Specifies the format of image to produce- PNG, SVG or AUTO. AUTO means generate FLASH if browser supports otherwise PNG. Constants are defined in UIDataView and begin with IMAGE_FOMART_. Supported in ADF Faces only.
Parameters:
format - A constant that represents the image format.

getImageFormat

public int getImageFormat()
Retrieves the format of image to produce- PNG, SVG or AUTO. AUTO means generate FLASH if browser supports otherwise PNG. Constants are defined in UIDataView and Supported in ADF Faces only.
Returns:
A constant the represents the image format

setSvgFontEmbedding

public void setSvgFontEmbedding(int embedding)
Set whether fonts are embedded in SVG. Valid values are defined in this class: SVG_FONT_EMBEDDING_ALL and SVG_FONT_EMBEDDING_NONE. Supported in ADF Faces only.
Parameters:
embedding - constant indicating whether fonts are embedded in SVG

setSvgFontEmbedding

public void setSvgFontEmbedding(java.lang.String embedding)
Set whether fonts are embedded in SVG. Valid values are defined in this class: SVG_FONT_EMBEDDING_ALL and SVG_FONT_EMBEDDING_NONE. Supported in ADF Faces only.
Parameters:
embedding - constant indicating whether fonts are embedded in SVG

getSvgFontEmbedding

public int getSvgFontEmbedding()
Determine whether fonts are embedded in SVG. The default value is SVG_FONT_EMBEDDING_ALL. Supported in ADF Faces only.
Returns:
constant indicating whether fonts are embedded in SVG

setSvgParentFormClientId

public void setSvgParentFormClientId(java.lang.String id)
Parameters:
id - parent form client ID
For internal use only. Application developers should not use this
Set the parent form client ID to use in SVG for submitting forms. This property should be set when the CoreGraph is rendered programmatically as a piece of a larger component.

getSvgParentFormClientId

public java.lang.String getSvgParentFormClientId()
Returns:
parent form client ID
For internal use only. Application developers should not use this
Get the parent form client ID to use in SVG for submitting forms.

setSvgOutputStream

public void setSvgOutputStream(java.io.OutputStream stream)
Parameters:
stream - OutputStream to write SVG to
For internal use only. Application developers should not use this
Set the OutputStream to use for writing SVG. Either this property or SvgWriter should be set when the CoreGraph is rendered programmatically as a piece of a larger component.

getSvgOutputStream

public java.io.OutputStream getSvgOutputStream()
Returns:
OutputStream to write SVG to
For internal use only. Application developers should not use this
Get the OutputStream to use for writing SVG.

setSvgWriter

public void setSvgWriter(java.io.Writer writer)
Parameters:
writer - Writer to write SVG to
For internal use only. Application developers should not use this
Set the Writer to use for writing SVG. Either this property or SvgOutputStream should be set when the CoreGraph is rendered programmatically as a piece of a larger component.

getSvgWriter

public java.io.Writer getSvgWriter()
Returns:
Writer to write SVG to
For internal use only. Application developers should not use this
Get the Writer to use for writing SVG.

setSvgDisposition

@Deprecated
public void setSvgDisposition(int disposition)
Deprecated. use setDisposition instead
Parameters:
disposition - how the SVG will be used
For internal use only. Application developers should not use this
Set the disposition of the SVG, which indicates how the SVG will be used, either standalone or as a fragment. Valid constants are defined in this class and begin with SVG_DISPOSITION_. This property should be set to SVG_DISPOSITION_FRAGMENT when the CoreGraph is rendered programmatically as a piece of a larger component.

getSvgDisposition

@Deprecated
public int getSvgDisposition()
Deprecated. use getDisposition instead
Returns:
constant indicating how the SVG will be used
For internal use only. Application developers should not use this
Get the disposition of the SVG, which indicates how the SVG will be used, either standalone or as a fragment. Valid constants are defined in this class and begin with SVG_DISPOSITION_.

setDisposition

public void setDisposition(int disposition)
Parameters:
disposition - how the graph will be used
For internal use only. Application developers should not use this
Set the disposition of the graph, which indicates how the graph will be used, either standalone or as a fragment. Valid constants are defined in this class and begin with DISPOSITION_. This property should be set to DISPOSITION_FRAGMENT when the CoreGraph is rendered programmatically as a piece of a larger component.

getDisposition

public int getDisposition()
Returns:
constant indicating how the graph will be used
For internal use only. Application developers should not use this
Get the disposition of the graph, which indicates how the graph will be used, either standalone or as a fragment. Valid constants are defined in this class and begin with DISPOSITION_.

getOtherProperties

@Deprecated
public java.lang.String getOtherProperties()
Deprecated. UIComponent APIs should be used instead.
Retrieves all other properties and data through xml.
Returns:
all other properties in the form of XML

setOtherProperties

@Deprecated
public void setOtherProperties(java.lang.String xml)
Deprecated. UIComponent APIs should be used instead.
Specifies all other properties and data through xml.
Parameters:
xml - other properties in the form of XML

setTabularData

public void setTabularData(java.util.List tableRows)
Specifies data for the Graph, from a table of data. Use this method to provide data row-by-row, from a file of tab-delimited or comma-separated values, or from a JDBC ResultSet.

When you use this method, you extract values from the file or ResultSet, organize them, and then pass them all in one call to this method. The graph creates a grid of data from the data that you pass in, and it uses this grid to populate itself.

For each data value in the table or result set, you construct an array of three Objects:

You add each Object array to a List (normally an ArrayList or a Vector). You pass the complete List to this method.

The following table shows a set of data to pass to the graph through this method:

Boston Bowties 97300
Boston Neckties 413812
Cleveland Bowties 48025
Cleveland Neckties 298511

The Object arrays would look like this, if you want the types of ties to appear in the legend (assuming that data rows in the grid represent series):

 Object[] tableRow1 = {"Boston", "Bowties", new Double(97300)};
 Object[] tableRow2 = {"Boston", "Neckties", new Double(413812)};
 Object[] tableRow3 = {"Cleveland", "Bowties", new Double(48025)};
 Object[] tableRow4 = {"Cleveland", "Neckties", new Double(298511)};

 // add the arrays to a List
 ArrayList data = new ArrayList();
 data.add(tableRow1);
 data.add(tableRow2);
 data.add(tableRow3);
 data.add(tableRow4);

 // pass the List to this method
 graph.setTabularData(data);
 

The grid that this method constructs and feeds to the graph looks like this:

  Boston Cleveland
Bowties 97300 48025
Neckties 413812 298511

Note that the data is not interactive. If you want users to be able to rotate or drill, you will have to provide a way for them to express that intention, and you must call this method again to display the rearranged data.

Parameters:
tableRows - List of data to plot in the graph.

getTabularData

public java.util.List getTabularData()

getRendersChildren

public boolean getRendersChildren()
Overrides:
getRendersChildren in class org.apache.myfaces.trinidad.component.UIXComponentBase

getComponentHandle

protected ComponentHandle getComponentHandle()
Convenience method for ComponentHandle subclasses to get instance of ComponentHandle.
Returns:
Instance of ComponentHandle

setComponentHandle

protected void setComponentHandle(ComponentHandle handle)
Convenience method for ComponentHandle subclasses to set instance of ComponentHandle.
Parameters:
handle - Instance of ComponentHandle

getShapeAttributes

protected ShapeAttributes getShapeAttributes()
Convenience method for UIDataview subclasses to get instance of ShapeAttributes.
Returns:
Instance of ShapeAttributes

setShapeAttributes

protected void setShapeAttributes(ShapeAttributes attrs)
Convenience method for UIDataview subclasses to set instance of ShapeAttributes.
Parameters:
attrs - Instance of ShapeAttributes

convertCompIdToFacetName

public abstract java.lang.String convertCompIdToFacetName(int id)
Subclasses must implement this method.

getShapeAttributesSet

public ShapeAttributesSet getShapeAttributesSet()

setShapeAttributesSet

public void setShapeAttributesSet(ShapeAttributesSet shapeAttributesSet)

setSvgEncodingScriptTag

public void setSvgEncodingScriptTag(boolean bEncode)
Parameters:
bEncode - true to encode script tag, false to not encode script tag
For internal use only. Application developers should not use this
Set whether SVG script tags will be encoded here and decoded on the client for rich views.

isSvgEncodingScriptTag

public boolean isSvgEncodingScriptTag()
Returns:
true if script tag will be encoded
For internal use only. Application developers should not use this
Determine whether SVG script tags will be encoded here and decoded on the client for rich views.

isTransferProperties

public boolean isTransferProperties()
For internal use only. Application developers should not use this
This method is called by Graph renderer.

getActiveDataProperties

public ActiveDataProperties getActiveDataProperties()
For internal use only. Application developers should not use this

setActiveDataProperties

public void setActiveDataProperties(ActiveDataProperties activeDataProperties)

setContentDelivery

public void setContentDelivery(int delivery)
Specifies whether content is sent with the page load or after the page load. Valid values are constants "whenAvailable", "lazy" and "immediate". Supported in ADF Faces only.
Parameters:
delivery - A constant that represents the contentDelivery setting.

setContentDelivery

public void setContentDelivery(java.lang.String delivery)
Specifies whether the content of the imageView is delivered immediately or lazily. Valid values are "whenAvailable", "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. Supported in ADF Faces only. The default value is "immediate".
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 "whenAvailable", "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 deliver 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). This property is mainly used to support dynamic resizing of the graph and gauge.
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). This property is mainly used to support dynamic resizing of the graph and gauge.
Returns:
the inlineStyle value

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

setDynamicResize

public final void setDynamicResize(java.lang.String dynamicResize)
This property is used to support dynamic resizing of the graph and gauge. Supported in ADF Faces only.
Parameters:
dynamicResize - the new dynamicResize value

getDynamicResize

public final java.lang.String getDynamicResize()
This property is used to support dynamic resizing of the graph and gauge. Supported in ADF Faces only.
Returns:
the dynamicResize value

getCustomizationId

@Deprecated
public java.lang.String getCustomizationId()
Deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
Returns:
the new customizationId value

setCustomizationId

@Deprecated
public void setCustomizationId(java.lang.String customizationId)
Deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
Parameters:
customizationId - the new customizationId value

getAnimationOnDataChange

public int getAnimationOnDataChange()
Returns the type of data change animations to apply. Supported in ADF Faces only.
Returns:
String representing the data change animation type

setAnimationOnDataChange

public void setAnimationOnDataChange(int type)
Specifies the type of data change animations to apply. Supported in ADF Faces only.
Parameters:
type - The data change animation to apply

setAnimationOnDataChange

public void setAnimationOnDataChange(java.lang.String type)
Specifies the type of data change animation to apply.
Parameters:
type - Valid values are:
  • none - Does not apply data change animation effects
  • activeData - (Default) Apply Active Data Service (ADS) data change animation events.
  • auto - Apply Partial Page Refresh (PPR) and ADS data change animation events for supported components.
  • alphaFade
  • conveyorFromLeft
  • conveyorFromRight
  • cubeToLeft
  • cubeToRight
  • flipLeft
  • flipRight
  • slideToLeft
  • slideToRight
  • transitionToLeft
  • transitionToRight
  • zoom

getAnimationIndicators

public int getAnimationIndicators()
Returns which data change indicators should be shown. Supported in ADF Faces only.
Returns:

setAnimationIndicators

public void setAnimationIndicators(int type)
Specifies which data change indicators should be shown. Supported in ADF Faces only.
Parameters:
type - the types of data change indicators to show

setAnimationIndicators

public void setAnimationIndicators(java.lang.String type)
Specifies which data change indicators should be shown. Supported in ADF Faces only.
Parameters:
type - the types of data change indicators to show.
  • NONE - Show no data change indicators
  • ALL - (Default) Show all data change indicators

getAnimationUpColor

public java.awt.Color getAnimationUpColor()
Returns the color used to indicate that a data value has increased. Supported in ADF Faces only.
Returns:
Color

setAnimationUpColor

public void setAnimationUpColor(java.awt.Color clr)
Specifies the color used to indicate that a data value has increased. Supported in ADF Faces only.
Parameters:
clr - Color to indicate that a data value increased.

getAnimationDownColor

public java.awt.Color getAnimationDownColor()
Returns the color used to indicate that a data value has decreased. Supported in ADF Faces only.
Returns:
Color

setAnimationDownColor

public void setAnimationDownColor(java.awt.Color clr)
Specifies the color used to indicate that a data value has decreased. Supported in ADF Faces only.
Parameters:
clr - Color to indicate that a data value decreased.

getAnimationDuration

public int getAnimationDuration()
Returns the animation duration in milliseconds Supported in ADF Faces only.
Returns:

setAnimationDuration

public void setAnimationDuration(int duration)
Specifies the animation duration in milliseconds Supported in ADF Faces only.
Parameters:
duration -

getAnimationOnDisplay

public int getAnimationOnDisplay()
Returns the type of initial rendering effect to apply. Supported in ADF Faces only.
Returns:

setAnimationOnDisplay

public void setAnimationOnDisplay(int type)
Specifies the type of initial rendering effect to apply. Supported in ADF Faces only.
Parameters:
type - Type of initial rendering effect

setAnimationOnDisplay

public void setAnimationOnDisplay(java.lang.String type)
Specifies the type of data change animation to apply.
Parameters:
type - Valid values are:
  • none - (Default) Do not show any initial rendering effect
  • auto - Apply an initial rendering effect automatically chosen based on the component type
  • alphaFade
  • conveyorFromLeft
  • conveyorFromRight
  • cubeToLeft
  • cubeToRight
  • flipLeft
  • flipRight
  • slideToLeft
  • slideToRight
  • transitionToLeft
  • transitionToRight
  • zoom

getVisualEffects

public int getVisualEffects()
Returns the type or types of visualEffect to apply.
Returns:

setVisualEffects

public void setVisualEffects(int type)
Specifies the type or types of visual effects to apply.
Parameters:
type - Type of visual effect to apply

setVisualEffects

public void setVisualEffects(java.lang.String type)
Specifies the type or types of visualEffect to apply.
Parameters:
type - Valid values are:
  • none - Apply no visual effects
  • auto - (Default) Apply visual effects automatically based on gauge type. Visual effect includes shadow, bevel and glow effect. Visual effect includes shadow, bevel and glow effect.

setFlashDefaultFontLoading

@Deprecated
public void setFlashDefaultFontLoading(int loading)
Deprecated. Set whether default fonts are loaded in FLASH from the middle tier. Valid values are defined in this class: FLASH_DEFAULT_FONT_LOADING_ALL and FLASH_DEFAULT_FONT_LOADING_NONE. The default value is FLASH_DEFAULT_FONT_LOADING_ALL. Supported in ADF Faces only.
Deprecated. Embedded or device fonts will be selected automatically based on need.
Parameters:
loading - constant indicating whether default fonts are loaded in FLASH from the middle-tier

setFlashDefaultFontLoading

@Deprecated
public void setFlashDefaultFontLoading(java.lang.String loading)
Deprecated. Set whether default fonts are loaded in FLASH from the middle tier. Valid values are defined in this class: FLASH_DEFAULT_FONT_LOADING_ALL and FLASH_DEFAULT_FONT_LOADING_NONE. The default value is FLASH_DEFAULT_FONT_LOADING_ALL. Supported in ADF Faces only.
Deprecated. Embedded or device fonts will be selected automatically based on need.
Parameters:
loading - constant indicating whether default fonts are loaded in FLASH from the middle-tier

getFlashDefaultFontLoading

@Deprecated
public int getFlashDefaultFontLoading()
Deprecated. Determine whether default fonts are loaded in FLASH from the middle tier. Valid values are defined in this class: FLASH_DEFAULT_FONT_LOADING_ALL and FLASH_DEFAULT_FONT_LOADING_NONE. The default value is FLASH_DEFAULT_FONT_LOADING_ALL. Supported in ADF Faces only.
Deprecated. Embedded or device fonts will be selected automatically based on need.
Returns:
constant indicating whether default fonts are loaded in FLASH from the middle tier

setFontURLMap

public void setFontURLMap(java.util.Map urlMap)
Set a Map containing fontNames and URLs to their font files. This is used in Flash to load font swf files from the middle tier. Supported in ADF Faces only.
Parameters:
urlMap - instance of Map containing a mapping of font names and URL's

getFontURLMap

public java.util.Map getFontURLMap()
Get a Map containing fontNames and URLs to their font files. This is used in Flash to load font swf files from the middle tier. Supported in ADF Faces only.
Returns:
constant indicating whether fonts are embedded or loaded from the middle tier.

getAttributeFormats

public java.util.List<AttributeFormat> getAttributeFormats()
Get the attribute format components for this view.
Returns:
a list of AttributeFormat components

setAttributeFormats

public void setAttributeFormats(java.util.List<AttributeFormat> attributeFormats)
Set the list of AttributeFormat components for this view.
Parameters:
a - list of AttributeFormat components

getFlashRenderingEngineSwfPath

public static java.lang.String getFlashRenderingEngineSwfPath(javax.faces.context.FacesContext context)
Returns:
the path to the Flash rendering engine SWF. If dvt-faces.jar is not in the classpath, then what will be returned is <path relative to context path>/engine_unknown.swf
For internal use only. Application developers should not use this
Get the path to the Flash rendering engine SWF, relative to the context path. The name of the rendering engine SWF is versioned (e.g., engine_20090723.swf) and the version number is taken from a file in dvt-faces.jar. If dvt-faces.jar is not in the classpath, then what will be returned is <path relative to context path>/engine_unknown.swf

getFlashVarsString

public java.lang.String getFlashVarsString(java.lang.String clientId)
Parameters:
clientId - client Id of this component
Returns:
flashVars string
For internal use only. Application developers should not use this
Get the flashVars string for non-dynamic flash rendering.

setDataUpdateHint

@Deprecated
public void setDataUpdateHint(java.lang.String hint)
Deprecated. this method should not be used by applications
Parameters:
hint -
For internal use only. Application developers should not use this
Set the dataUpdateHint to be used when rendering this UIImageView.

getDataUpdateHint

@Deprecated
public java.lang.String getDataUpdateHint()
Deprecated. this method should not be used by applications
Returns:
String hint for the data update
For internal use only. Application developers should not use this
Gets the dataUpdateHint to be used when rendering this UIImageView.

setDataCache

@Deprecated
public void setDataCache(DataUpdateCache cache)
Deprecated. this method should not be used by applications
Parameters:
cache -
For internal use only. Application developers should not use this
Set the DataUpdateCache to be used when rendering this UIImageView.

getDataCache

@Deprecated
public DataUpdateCache getDataCache()
Deprecated. this method should not be used by applications
Returns:
DataUpdateCache
For internal use only. Application developers should not use this
Gets the DataUpdateCache to be used when rendering this UIImageView.

isUpdated

public boolean isUpdated()
For internal use only. Application developers should not use this
Returns true if the component has been updated since the last time transferProperties was called.

setUpdated

public void setUpdated(boolean updated)
For internal use only. Application developers should not use this

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
Overrides:
getBeanType in class UIDataView

setProperty

protected void setProperty(org.apache.myfaces.trinidad.bean.PropertyKey key,
                           java.lang.Object value)
Overrides:
setProperty in class org.apache.myfaces.trinidad.component.UIXComponentBase

setPopupHelperBounds

public void setPopupHelperBounds(java.awt.Rectangle bounds)
Sets the bounds used to help in positioning a popup within the imageview region. This is generally tied to the subcomponent that fired the PPR event.
Parameters:
bounds -
For internal use only. Application developers should not use this

getPopupHelperBounds

public java.awt.Rectangle getPopupHelperBounds()
Returns the bounds used to help position a popup within the imageview region.
Returns:
For internal use only. Application developers should not use this

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.