|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 1 (11.1.1.9.0) E52941-01 |
||||||||
| 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.BaseText
oracle.dss.graph.BaseTickLabel
oracle.dss.graph.O1TickLabel
public class O1TickLabel
Identifies a tick mark on the O1-axis of the graph. This usually contains the names of the dimension or measure that the O1-axis represents.
| Field Summary | |
|---|---|
protected oracle.dss.graph.pfj.draw.IdentObj |
m_identObj2 |
protected boolean |
wordWrapEnabled |
| Fields inherited from class oracle.dss.graph.BaseText |
|---|
m_font |
| Fields inherited from class oracle.dss.dataView.BaseComponentXML |
|---|
m_jsfHashMap |
| Constructor Summary | |
|---|---|
O1TickLabel(CommonGraph graph) |
|
| Method Summary | |
|---|---|
static int |
convertAutomaticRotationToInt(java.lang.String string) |
static int |
convertTickLabelSkipModeToInt(java.lang.String string) |
protected java.lang.String |
convertTickLabelSkipModeToString(int value) |
int |
getAutomaticRotation()Retrieves the angle of automatic rotation for the text within the rectangle for each of the O1-axis tick labels. |
protected java.lang.String |
getComponentName() |
boolean |
getStyleXML(boolean allProperties, oracle.dss.util.xml.ObjectNode node) |
int |
getTickLabelSkipCount()Retrieves the number of O1-axis tick labels that the graph hides between each one that is displayed. |
int |
getTickLabelSkipFirst()Retrieves the index of the first O1-axis tick label that is skipped. |
int |
getTickLabelSkipMode()Retrieves the type of skipping that is used for the O1-axis tick labels. |
boolean |
isTextFittingAutomatic()Indicates whether all of the O1-axis tick labels are automatically moved and resized relative to the size of the graph. |
boolean |
isTickLabelStaggered()Indicates whether all of the O1-axis tick labels are staggered. |
boolean |
isWordWrapEnabled()Indicates whether word wrap is enabled for all of the O1-axis tick labels. |
void |
resetStyle() |
boolean |
selectObject(int layer, int group)Selects this O1-axis tick label in the graph. |
void |
setAutomaticRotation(int orient)Specifies the angle of automatic rotation for the text within the rectangle for each of the O1-axis tick labels. |
void |
setHorizontalAlignment(int a)Specifies the horizontal alignment of the text within the rectangle for each of the O1-axis tick labels.This property is also tied to the O1DrillLable When the text has been rotated to a vertical position, the horizontal alignment properties appear to move the text up and down, rather than left and right. |
void |
setStyleXML(oracle.dss.util.xml.ObjectNode node) |
void |
setTextFittingAutomatic(boolean yesNo)Specifies whether all of the O1-axis tick labels are automatically moved and resized relative to the size of the graph. |
void |
setTextRotation(int orient)Specifies the angle of rotation for the text within the rectangle for each of the O1-axis tick labels. |
void |
setTickLabelSkipCount(int count)Specifies the number of O1-axis tick labels that the graph hides between each one that is displayed. |
void |
setTickLabelSkipFirst(int first)Specifies the index of the first 01-axis tick label that is skipped. |
void |
setTickLabelSkipMode(int mode)Specifies the type of skipping that is used for the O1-axis tick labels. |
void |
setTickLabelStaggered(boolean yesNo)Specifies whether all of the O1-axis tick labels are staggered. |
void |
setWordWrapEnabled(boolean yesNo)Specifies whether word wrap is enabled for all of the O1-axis tick labels. |
| Methods inherited from class oracle.dss.graph.BaseTickLabel |
|---|
getHorizontalAlignment, getNonstyleXML, getTextRotation, isVisible, setNonstyleXML, setVisible, setXML |
| Methods inherited from class oracle.dss.graph.BaseText |
|---|
_getGraphFont, getDataviewFont, getFont, getGraphFont, isFontSizeAbsolute, setFont, setFontSizeAbsolute, truncateText |
| Methods inherited from class oracle.dss.dataView.BaseComponentXML |
|---|
getStyleXML, getXML, setNonstyleXML, setXML, setXML, setXML |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected boolean wordWrapEnabled
protected oracle.dss.graph.pfj.draw.IdentObj m_identObj2
| Constructor Detail |
|---|
public O1TickLabel(CommonGraph graph)
graph - The graph that this object belongs to.| Method Detail |
|---|
public boolean selectObject(int layer,
int group)
layer identifies whether to select the outer layer (layer 0) or the inner layer (layer 1).
For example, if a time axis has month labels next to the axis and year labels below the month labels, then the year labels are layer 0, and the month labels are layer 1.
If the O1-axis is not a time axis, then the layer parameter is irrelevant.
selectObject in class BaseTickLabellayer - If the axis is a time axis, then pass 0 for an outer label or 1 for an inner label. If the axis is not a time axis, then pass any integer.group - The group that this tick label belongs to.true if successful, false if not.public boolean isTextFittingAutomatic()
isTextFittingAutomatic in class BaseTickLabeltrue if they are moved and resized, false if they are independent from the size of the graph.Graph.setAutoLayout(int)public void setTextFittingAutomatic(boolean yesNo)
Graph automatic layout ignores this property.
setTextFittingAutomatic in class BaseTickLabelyesNo - true to make them automatically moved and resized, false to make them independent from the size of the graph.Graph.setAutoLayout(int)public int getAutomaticRotation()
doAutoLayout method always sets this property to AR_NO_ROTATE.
doAutoLayout(BaseGraphComponent.HONOR_PROPERTIES) respects this property. doAutoLayout(BaseGraphComponent.RESET_PROPERTIES) treats this property as AR_HORIZ_ROTATE_270.
BaseGraphComponent.AR_NO_ROTATE, BaseGraphComponent.AR_HORIZ_ROTATE_90, BaseGraphComponent.AR_HORIZ_ROTATE_270, Graph.setAutoLayout(int)public void setAutomaticRotation(int orient)
doAutoLayout method always sets this property to AR_NO_ROTATE.
doAutoLayout(BaseGraphComponent.HONOR_PROPERTIES) respects this property. doAutoLayout(BaseGraphComponent.RESET_PROPERTIES) treats this property as AR_HORIZ_ROTATE_270.
orient - A constant that represents the angle of automatic rotation for the text within the rectangle for each of the O1-axis tick labels. Valid constants are listed in the See Also section. If you pass an invalid value, then the graph does not change the AutomaticRotation property value. It logs a message with the error handler.BaseGraphComponent.AR_NO_ROTATE, BaseGraphComponent.AR_HORIZ_ROTATE_90, BaseGraphComponent.AR_HORIZ_ROTATE_270public void setHorizontalAlignment(int a)
setHorizontalAlignment in interface HorizontalAlignmentsetHorizontalAlignment in class BaseTickLabela - 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 void setTextRotation(int orient)
doAutoLayout(BaseGraphComponent.HONOR_PROPERTIES) respects this property. doAutoLayout(BaseGraphComponent.RESET_PROPERTIES) treats this property as TR_HORIZ.
setTextRotation in class BaseTickLabelorient - The angle of rotation for the text within the rectangle for each of the O1-axis tick labels. If you pass an invalid value, then the graph does not change the TextRotation property value. It logs a message with the error handler.BaseGraphComponent.TR_HORIZ, BaseGraphComponent.TR_HORIZ_ROTATE_90, BaseGraphComponent.TR_HORIZ_ROTATE_270, Graph.setAutoLayout(int)public int getTickLabelSkipCount()
TickLabelSkipMode property is set to TLS_MANUAL.
Automatic graph layout respects this property, if TickLabelSkipMode is TLS_MANUAL. Otherwise, automatic layout ignores this property. The doAutoLayout method sets it as needed, if TickLabelSkipMode is TLS_AUTOMATIC or if you pass RESET_PROPERTIES as the argument to doAutoLayout.
setTickLabelSkipMode(int), Graph.setAutoLayout(int), Graph.doAutoLayout(int)public void setTickLabelSkipCount(int count)
TickLabelSkipMode property is set to TLS_MANUAL.
Automatic graph layout respects this property, if TickLabelSkipMode is TLS_MANUAL. Otherwise, automatic layout ignores this property. The doAutoLayout method sets it as needed, if TickLabelSkipMode is TLS_AUTOMATIC or if you pass RESET_PROPERTIES as the argument to doAutoLayout.
count - The number of O1-axis tick labels that the graph hides between each one that is displayed.setTickLabelSkipMode(int), Graph.setAutoLayout(int), Graph.doAutoLayout(int)public int getTickLabelSkipFirst()
TickLabelSkipMode property is set to TLS_MANUAL.
Automatic graph layout respects this property, if TickLabelSkipMode is TLS_MANUAL. Otherwise, automatic layout ignores this property. The doAutoLayout method sets it as needed, if TickLabelSkipMode is TLS_AUTOMATIC or if you pass RESET_PROPERTIES as the argument to doAutoLayout.
setTickLabelSkipMode(int), setTickLabelSkipCount(int), Graph.setAutoLayout(int), Graph.doAutoLayout(int)public void setTickLabelSkipFirst(int first)
TickLabelSkipMode property is set to TLS_MANUAL.
Automatic graph layout respects this property, if TickLabelSkipMode is TLS_MANUAL. Otherwise, automatic layout ignores this property. The doAutoLayout method sets it as needed, if TickLabelSkipMode is TLS_AUTOMATIC or if you pass RESET_PROPERTIES as the argument to doAutoLayout.
first - The index of the first O1-axis tick label that is skipped. This index should not be greater than the value of TickLabelSkipCount. For example, if you set the graph to skip two labels between each displayed label, you cannot start with the fourth label (index 3).setTickLabelSkipMode(int), setTickLabelSkipCount(int), Graph.setAutoLayout(int), Graph.doAutoLayout(int)public int getTickLabelSkipMode()
The doAutoLayout method always sets this property to TLS_AUTOMATIC. doAutoLayout(BaseGraphComponent.HONOR_PROPERTIES) respects this property. doAutoLayout(BaseGraphComponent.RESET_PROPERTIES) treats this property as TLS_AUTOMATIC.
setTickLabelSkipCount(int), setTickLabelSkipFirst(int), BaseGraphComponent.TLS_AUTOMATIC, BaseGraphComponent.TLS_MANUAL, BaseGraphComponent.TLS_NOSKIP, Graph.setAutoLayout(int), Graph.doAutoLayout(int)public void setTickLabelSkipMode(int mode)
The doAutoLayout method always sets this property to TLS_MANUAL so you can adjust the related properties as needed. doAutoLayout(BaseGraphComponent.HONOR_PROPERTIES) respects this property. doAutoLayout(BaseGraphComponent.RESET_PROPERTIES) treats this property as TLS_AUTOMATIC.
mode - A constant that represents the type of skipping that is used for the O1-axis tick labels. Valid constants are listed in the See Also section. If you enter an invalid parameter value, then the graph will log an ErrorHandler message, and will not change the TickLabelSkipMode property.BaseGraphComponent.TLS_AUTOMATIC, BaseGraphComponent.TLS_MANUAL, BaseGraphComponent.TLS_NOSKIP, Graph.setAutoLayout(int), Graph.doAutoLayout(int)public boolean isTickLabelStaggered()
doAutoLayout sets it as needed.isTickLabelStaggered in class BaseTickLabeltrue if they are staggered, false if they are aligned.Graph.setAutoLayout(int), Graph.doAutoLayout(int)public void setTickLabelStaggered(boolean yesNo)
doAutoLayout sets it as needed.setTickLabelStaggered in class BaseTickLabelyesNo - true to stagger them, false to align them.Graph.setAutoLayout(int), Graph.doAutoLayout(int)public boolean isWordWrapEnabled()
doAutoLayout sets it as needed when the level is set to RESET_PROPERTIES. doAutoLayout respects this property in the HONOR_PROPERTIES mode.isWordWrapEnabled in interface WordWrapEnabledtrue if it is enabled, false if it is not.Graph.setAutoLayout(int), Graph.doAutoLayout(int)public void setWordWrapEnabled(boolean yesNo)
doAutoLayout sets it as needed when the level is set to RESET_PROPERTIES. doAutoLayout respects this property in the HONOR_PROPERTIES mode.setWordWrapEnabled in interface WordWrapEnabledyesNo - true to wrap words, false to prohibit wrapping.Graph.setAutoLayout(int), Graph.doAutoLayout(int)protected java.lang.String getComponentName()
getComponentName in class BaseComponentXMLprotected java.lang.String convertTickLabelSkipModeToString(int value)
public static int convertTickLabelSkipModeToInt(java.lang.String string)
public static int convertAutomaticRotationToInt(java.lang.String string)
public void setStyleXML(oracle.dss.util.xml.ObjectNode node)
setStyleXML in class BaseTickLabel
public boolean getStyleXML(boolean allProperties,
oracle.dss.util.xml.ObjectNode node)
getStyleXML in class BaseTickLabelpublic void resetStyle()
resetStyle in class BaseTickLabel
|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 1 (11.1.1.9.0) E52941-01 |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||