|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 2 (11.1.2.3.0) E17492-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.dss.dataView.BaseComponentXML
oracle.dss.graph.BaseGraphComponent
oracle.dss.graph.Annotation
public class Annotation
This class
Field Summary | |
---|---|
protected GraphFont |
m_font |
protected int |
m_group |
protected oracle.dss.graph.pfj.draw.IdentObj |
m_idBox |
protected int |
m_series |
protected SFX |
m_sfx |
Fields inherited from class oracle.dss.dataView.BaseComponentXML |
---|
m_jsfHashMap |
Constructor Summary | |
---|---|
Annotation(CommonGraph graph, int series, int group) |
Method Summary | |
---|---|
java.awt.Color |
getBorderColor() Retrieves the border color of this annotation. |
protected java.lang.String |
getComponentName() |
java.awt.Color |
getFillColor() Retrieves the background color of the annotation. |
java.awt.Font |
getFont() Retrieves a Font object for the text of the annotation. |
GraphFont |
getGraphFont() Retrieves a GraphFont object for the text of the annotation. |
int |
getHorizontalAlignment() Retrieves the horizontal alignment of this annotation. |
int |
getID() Retrieves the ID of this ReferenceObject. |
GraphConstants.AnnotationLocation |
getLocation() Returns the location of this annotation. |
GraphConstants.AnnotationPosition |
getPosition() Returns the position of this annotation. When the position is set to GraphConstants.AnnotationPosition.ABSOLUTE or GraphConstants.AnnotationPosition.PERCENTAGE, the annotation is positioned at exactly the xy location specified, without taking into account overlap or clipping. |
SFX |
getSFX() Retrieves the SFX object for this exceptional riser. |
java.lang.String |
getText() Retrieves the text for the annotation. |
int |
getVerticalAlignment() Retrieves the vertical alignment of this annotation. |
protected oracle.dss.util.xml.ObjectNode |
getXML(boolean allProperties, boolean allOverriddenProperties) |
double |
getXValue() Returns the x value of the annotation. |
double |
getYValue() Returns the y value of the annotation. |
boolean |
isVisible() Indicates whether the annotation is visible. |
boolean |
selectObject(int series, int group) Selects the annotation on the graph. |
void |
setBorderColor(java.awt.Color newColor) Specifies the border color of this annotation. |
void |
setFillColor(java.awt.Color newColor) Specifies the background color of the annotation. |
void |
setFont(java.awt.Font f) Specifies a Font object for the text of the annotation. |
void |
setHorizontalAlignment(int a) Specifies the horizontal alignment of this annotation. |
void |
setLocation(GraphConstants.AnnotationLocation location) Specifies the location of this annotation. |
void |
setPosition(GraphConstants.AnnotationPosition pos) Specifies the position of this annotation. When the position is set to GraphConstants.AnnotationPosition.ABSOLUTE or GraphConstants.AnnotationPosition.PERCENTAGE, the annotation is positioned at exactly the xy location specified, without taking into account overlap or clipping. |
void |
setText(java.lang.String str) Specifies the text of the annotation. |
void |
setVerticalAlignment(int a) Specifies the vertical alignment of this annotation. |
void |
setVisible(boolean yesNo) Specifies whether the annotation is visible. |
void |
setXML(oracle.dss.util.xml.ObjectNode node) |
void |
setXML(oracle.dss.util.xml.ObjectNode node, java.util.HashMap map) |
void |
setXValue(double value) Set the x value of the annotation. |
void |
setYValue(double value) Set the y value of the annotation. |
Methods inherited from class oracle.dss.dataView.BaseComponentXML |
---|
getNonstyleXML, getStyleXML, getStyleXML, getXML, setNonstyleXML, setNonstyleXML, setStyleXML, setXML, setXML |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected SFX m_sfx
protected GraphFont m_font
protected oracle.dss.graph.pfj.draw.IdentObj m_idBox
protected int m_series
protected int m_group
Constructor Detail |
---|
public Annotation(CommonGraph graph, int series, int group)
graph
- The graph that this object belongs to.Method Detail |
---|
public boolean selectObject(int series, int group)
selectObject
in class BaseGraphComponent
series
- Any integer.group
- Any integer.true
if successful, false
if not.public void setPosition(GraphConstants.AnnotationPosition pos)
pos
- the position to use for this annotationGraphConstants.AnnotationPosition
public GraphConstants.AnnotationPosition getPosition()
GraphConstants.AnnotationPosition
public GraphConstants.AnnotationLocation getLocation()
GraphConstants.AnnotationLocation
public void setLocation(GraphConstants.AnnotationLocation location)
location
- the location to use for this annotationGraphConstants.AnnotationLocation
public void setXValue(double value)
value
- the x value of the annotationpublic double getXValue()
public void setYValue(double value)
value
- the y value of the annotationpublic double getYValue()
public java.awt.Color getBorderColor()
public void setBorderColor(java.awt.Color newColor)
newColor
- The border color of this annotation.public java.awt.Color getFillColor()
public void setFillColor(java.awt.Color newColor)
newColor
- The background color for the annotation. The default is (0xaffaf6f0)public boolean isVisible()
true
if it is visible, false
if it is invisible.public void setVisible(boolean yesNo)
yesNo
- true
to make it visible, false
to make it invisible.public GraphFont getGraphFont()
GraphFont
object for the text of the annotation. Use the GraphFont
objects to specify and retrieve font properties such as name, color, style, and size in virtual coordinates. Virtual coordinates make the font size relative to the size of the graph.GraphFont
object for the object.public void setFont(java.awt.Font f)
Font
object for the text of the annotation. This is the awt
object with properties such as name, style, and absolute size.f
- A Font
object for this object.public java.awt.Font getFont()
Font
object for the text of the annotation. This is the awt
object with properties such as name, style, and absolute size.Font
object for the object.public java.lang.String getText()
public void setText(java.lang.String str)
str
- The text of the annotation.public int getHorizontalAlignment()
SwingConstants.LEFT
, SwingConstants.CENTER
, and SwingConstants.RIGHT
.swing
constant that represents the horozontal alignment of this annotationpublic void setHorizontalAlignment(int a)
a
- A Swing
constant that represents the horizontal alignment for the text of the title. Valid constants are SwingConstants.LEFT
, SwingConstants.CENTER
, and SwingConstants.RIGHT
.public int getVerticalAlignment()
swing
constants are SwingConstants.TOP
, SwingConstants.CENTER
, and SwingConstants.BOTTOM
.getVerticalAlignment
in interface VerticalAlignment
swing
constant that represents the vertical alignment of the annotation.public void setVerticalAlignment(int a)
swing
constants are SwingConstants.TOP
, SwingConstants.CENTER
, and SwingConstants.BOTTOM
.setVerticalAlignment
in interface VerticalAlignment
a
- A swing
constant that represents the vertical alignment of the annotation.public SFX getSFX()
SFX
object for this exceptional riser. This allows you to retrieve and specify attributes for special effects.SFX
object for this exceptional riser.public int getID()
protected java.lang.String getComponentName()
getComponentName
in class BaseComponentXML
protected oracle.dss.util.xml.ObjectNode getXML(boolean allProperties, boolean allOverriddenProperties)
public void setXML(oracle.dss.util.xml.ObjectNode node, java.util.HashMap map)
setXML
in class BaseComponentXML
public void setXML(oracle.dss.util.xml.ObjectNode node)
setXML
in class BaseComponentXML
|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 2 (11.1.2.3.0) E17492-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |