|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 2 (11.1.2.2.0) E17492-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.adf.view.faces.bi.component.BIComplexAttributeBase
oracle.adf.view.faces.bi.component.graph.ReferenceObject
public class ReferenceObject
Field Summary | |
---|---|
static org.apache.myfaces.trinidad.bean.PropertyKey |
ASSOCIATION_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
COLOR_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
DISPLAYED_IN_LEGEND_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
HIGH_VALUE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
INDEX_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
LINE_STYLE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
LINE_VALUE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
LINE_WIDTH_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
LOCATION_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
LOW_VALUE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
RENDERED_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SERIES_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SFX_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SHORTDESC_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
TEXT_KEY |
static org.apache.myfaces.trinidad.bean.FacesBean.Type |
TYPE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
TYPE_KEY |
Fields inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase |
---|
ID_KEY, m_parent, TRANSIENT_KEY |
Constructor Summary | |
---|---|
ReferenceObject() |
Method Summary | |
---|---|
int |
getAssociation() Retrieves a constant that identifies the component this reference object is associated with. |
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType() |
java.awt.Color |
getColor() Retrieves the color of the reference object. |
java.lang.Object |
getHighValue() Retrieves the high value of the reference Area. |
int |
getIndex() Retrieves the index of this reference line. |
int |
getLineStyle() Retrieves the style of the line. |
java.lang.Object |
getLineValue() Retrieves the value at which the reference line is displayed. |
int |
getLineWidth() Retrieves the width of the reference line in pixels. |
int |
getLocation() Returns the location of the reference object. |
java.lang.Object |
getLowValue() Retrieves the low value of the reference Area. |
int |
getSeries() Retrieves the series this reference object is associated with. |
java.lang.String |
getShortDesc() Retrieves the short description of the reference object. |
SpecialEffects |
getSpecialEffects() Retrieve the special effect of the reference object |
java.lang.String |
getText() Retrieves the text for the reference object. |
int |
getType() Returns the type of the reference object. |
boolean |
isDisplayedInLegend() Indicates whether the reference object appears in the legend. |
void |
setAssociation(int component) Specifies a constant that represents the component this reference object is associated with. |
void |
setAssociation(java.lang.String component) A constant that identifies the component that this reference object is associated with. |
void |
setColor(java.awt.Color newColor) Specifies the color of the reference object. |
void |
setDisplayedInLegend(boolean visible) Specifies whether to display the reference object in the legend. |
void |
setHighValue(java.lang.Object value) Specifies the high value of the reference area. |
void |
setIndex(int index) Specifies the index of this reference line. |
void |
setLineStyle(int style) Specifies the style of the line. |
void |
setLineStyle(java.lang.String style) Specifies the style of the pareto line. |
void |
setLineValue(java.lang.Object value) Specifies the value at which the reference line is displayed. |
void |
setLineWidth(int width) Specifies the width of the reference line in pixels. |
void |
setLocation(int location) Specifies the location of the reference object. |
void |
setLocation(java.lang.String location) Specifies whether the reference line is to appear in front of or behind the graph. |
void |
setLowValue(java.lang.Object value) Specifies the low value of the reference area. |
void |
setSeries(int series) Specifies the series this reference object is associated with. |
void |
setShortDesc(java.lang.String shortDesc) Specifies the short description of the reference object. |
void |
setSpecialEffects(SpecialEffects sfx) Specifies the special effect of the reference object |
void |
setText(java.lang.String str) Specifies the text of the reference object. |
void |
setType(int type) Specifies the type of the reference object. |
void |
setType(java.lang.String type) Identifies whether the reference object represents a line or an area. |
Methods inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase |
---|
applyProperties, getBooleanProperty, getFacesBean, getId, getParent, getProperty, getPropertyKey, getSetAttributeIndex, isTransient, isUpdated, processSetAttribute, processSetAttributeAndAdd, restoreState, saveState, setBooleanProperty, setId, setParent, setProperty, setTransient, setUpdated |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey TYPE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey ASSOCIATION_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey LOCATION_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SERIES_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey COLOR_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey LINE_WIDTH_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey LINE_STYLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey TEXT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey RENDERED_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey LINE_VALUE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey LOW_VALUE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey HIGH_VALUE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DISPLAYED_IN_LEGEND_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey INDEX_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SFX_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORTDESC_KEY
Constructor Detail |
---|
public ReferenceObject()
Method Detail |
---|
public void setIndex(int index)
index
-public int getIndex()
public int getType()
BaseGraphComponent.RO_LINE
, BaseGraphComponent.RO_AREA
public void setType(int type)
type
- Constant that identifies the type of the reference object. By default object is of type reference line Valid constants are listed in the See Also section.BaseGraphComponent.RO_LINE
, BaseGraphComponent.RO_AREA
public void setType(java.lang.String type)
type
- Constant that identifies the type of the reference object. By default object is of type reference line Valid constants are
public int getLocation()
BaseGraphComponent.RO_FRONT
, BaseGraphComponent.RO_BACK
public void setLocation(int location)
location
- Constant that identifies the location of the reference object. By default object is located at the back Valid constants are listed in the See Also section.BaseGraphComponent.RO_FRONT
, BaseGraphComponent.RO_BACK
public void setLocation(java.lang.String location)
location
- Constant that identifies the location of the reference object. By default object is located at the back. Valid constants are
public int getAssociation()
GraphConstants.Y1AXIS
, GraphConstants.Y2AXIS
, GraphConstants.X1AXIS
, GraphConstants.SERIES
public void setAssociation(int component)
component
- Constant that identifies the component this reference object is associated with. By default it is associated with the Y1AXIS.GraphConstants.Y1AXIS
, GraphConstants.Y2AXIS
, GraphConstants.X1AXIS
, GraphConstants.SERIES
public void setAssociation(java.lang.String component)
component
- Constant that identifies the component this reference object is associated with. By default it is associated with the Y1AXIS.
public int getSeries()
public void setSeries(int series)
series
- The zero-based number of the series that this reference object is associated with. By default it is associated with the first series.public java.awt.Color getColor()
public void setColor(java.awt.Color newColor)
newColor
- The color for the reference object. The default is Red (0xffcc0000)public int getLineWidth()
public void setLineWidth(int width)
width
- The width for the reference line in pixels. The default line width is single pixel.public int getLineStyle()
BaseGraphComponent.LS_SOLID
, BaseGraphComponent.LS_DASH
, BaseGraphComponent.LS_DOTTED
, BaseGraphComponent.LS_DASH_DOT
public void setLineStyle(int style)
style
- The style of the line. By default the line style is LS_SOLIDBaseGraphComponent.LS_SOLID
, BaseGraphComponent.LS_DASH
, BaseGraphComponent.LS_DOTTED
, BaseGraphComponent.LS_DASH_DOT
public void setLineStyle(java.lang.String style)
style
- The style of the line.
public java.lang.String getText()
public void setText(java.lang.String str)
str
- The text of the reference object.public boolean isDisplayedInLegend()
true
if the specified reference object appears in the legend, false
if it does not.public void setDisplayedInLegend(boolean visible)
visible
- true
to display the object in the legend, false
to remove it from the legend.public java.lang.Object getLineValue()
public void setLineValue(java.lang.Object value)
value
- The value at which to display the reference object. This Object will be of type Number when reference object is of type "Line".public java.lang.Object getLowValue()
public void setLowValue(java.lang.Object value)
value
- The low value of the reference area.public java.lang.Object getHighValue()
public void setHighValue(java.lang.Object value)
value
- The high value of the reference area.public SpecialEffects getSpecialEffects()
public void setSpecialEffects(SpecialEffects sfx)
sfx
- the special effectpublic void setShortDesc(java.lang.String shortDesc)
shortDesc
- the short descriptionpublic java.lang.String getShortDesc()
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class BIComplexAttributeBase
|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 2 (11.1.2.2.0) E17492-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |