All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class jclass.chart.JCAxisTitle

java.lang.Object
   |
   +----jclass.chart.TrackChange
           |
           +----jclass.chart.ChartRegion
                   |
                   +----jclass.chart.ChartText
                           |
                           +----jclass.chart.JCAxisTitle

public class JCAxisTitle
extends ChartText
implements HTMLHandler
JCAxisTitle controls the appearance of an axis title (ie title placement and text).

Properties

Name Description
Adjust The Adjust property determines how text is justified (positioned) in the label. If the contents of the ChartText are a JCString, this has no effect. Valid values include ChartText.LEFT, ChartText.CENTER and ChartText.RIGHT. Default value is ChartText.LEFT.
Background The Background property determines the background color used to draw inside the chart region. Note that the Background property is inherited from the parent ChartText.
BorderStyle The BorderStyle property determines the width and style of border drawn around the chart region. By default, no border is drawn, and BorderStyle is null.
Font The Font property determines what font is used to render text inside the chart region. Note that the Font property is inherited from the parent ChartText.
Foreground The Foreground property determines the foreground color used to draw inside the chart region. Note that the Foreground property is inherited from the parent ChartText.
Height The Height property defines the height of the chart region. The default value is calculated.
IsShowing The IsShowing property determines whether the associated Axis is currently visible. Default value is true.
Left The Left property determines the location of the left of the chart region. This property is read-only.
Placement The Placement property controls where the JCAxis title is placed relative to the "opposing" axis. Valid values include JCLegend.NORTH or JCLegend.SOUTH for horizontal axes, and JCLegend.EAST, JCLegend.WEST, JCLegend.NORTHEAST, JCLegend.SOUTHEAST, JCLegend.NORTHWEST or JCLegend.SOUTHEAST for vertical axes. The default value is calculated.
PlacementIsDefault The PlacementIsDefault property determines whether Chart is responsible for calculating a reasonable default placement for the axis title. Default value is true.
Rotation The Rotation property controls the rotation of the label. Valid values include ChartText.DEG_90, ChartText.DEG_180, ChartText.DEG_270 and ChartText.DEG_0. Default value is ChartText.DEG_0.
Text The Text property is a string property that represents the text to be displayed inside the chart label. In some cases, the Text property is used to create a JCString instance. Default value is " " (nothing).
Top The Top property determines the location of the top of the chart region. This property is read-only.
Width The Width property defines the width of the chart region. The default value is calculated.


Variable Index

 o anchor_strings
 o anchor_values

Constructor Index

 o JCAxisTitle()
Default constructor for JCAxisTitle.
 o JCAxisTitle(String)
Constructor for JCAxisTitle that sets the contents of the title as a convenience.
 o JCAxisTitle(String, boolean)
Constructor for JCAxisTitle that sets the contents of the title, optionally specifying that the string contents should be interpreted as a JCString.

Method Index

 o getPlacement()
Gets the Placement property of the JCTitleAxis.
 o getPlacementIsDefault()
Gets the value of the PlacementIsDefault property.
 o loadParams(String, JCChart)
Load JCChart parameters from HTML file
 o saveParams(String, JCChart)
Save JCChart parameters as HTML tags
 o setPlacement(int)
Sets the Placement property of the JCTitleAxis.
 o setPlacementIsDefault(boolean)
Sets the value of the PlacementIsDefault property.
 o setText(String, boolean, boolean)
Sets the Text property.

Variables

 o anchor_strings
 public static final String anchor_strings[]
 o anchor_values
 public static final int anchor_values[]

Constructors

 o JCAxisTitle
 public JCAxisTitle()
Default constructor for JCAxisTitle. Makes an unattached axis title.

 o JCAxisTitle
 public JCAxisTitle(String title)
Constructor for JCAxisTitle that sets the contents of the title as a convenience.

Parameters:
title - String representing the axis title
 o JCAxisTitle
 public JCAxisTitle(String title,
                    boolean jcstring)
Constructor for JCAxisTitle that sets the contents of the title, optionally specifying that the string contents should be interpreted as a JCString.

Parameters:
title - String/Unparsed JCString representing the axis title
jcstring - if true, the string is parsed as a JCString. Otherwise, it is assumed the string is a simple string.

Methods

 o setText
 public void setText(String nc,
                     boolean jcs,
                     boolean setShowing)
Sets the Text property.

Parameters:
nc - new string contents of the ChartText instance. If the jcs parameter is true, nc is parsed as a JCString.
jcs - if true, the string is converted to a JCString. Otherwise, the raw text is used in the label.
setShowing - if true, isShowing indication is set to true
Overrides:
setText in class ChartText
 o setPlacement
 public void setPlacement(int place)
Sets the Placement property of the JCTitleAxis. The Placement property controls where the JCAxis title is placed relative to the "opposing" axis. Valid values include JCLegend.NORTH or JCLegend.SOUTH for horizontal axes, and JCLegend.EAST, JCLegend.WEST, JCLegend.NORTHEAST, JCLegend.SOUTHEAST, JCLegend.NORTHWEST or JCLegend.SOUTHEAST for vertical axes.

Parameters:
place - one of NORTH or SOUTH for horizontal axes, and EAST/WEST/NORTHEAST/SOUTHEAST/NORTHWEST/SOUTHEAST for vertical axes.
Throws: IllegalArgumentException
If Placement is not one of NORTH, SOUTH, EAST, WEST, NORTHEAST, NORTHWEST, SOUTHEAST or SOUTHWEST.
 o getPlacement
 public int getPlacement()
Gets the Placement property of the JCTitleAxis. The Placement property controls where the JCAxis title is placed relative to the "opposing" axis. Valid values include JCLegend.NORTH or JCLegend.SOUTH for horizontal axes, and JCLegend.EAST, JCLegend.WEST, JCLegend.NORTHEAST, JCLegend.SOUTHEAST, JCLegend.NORTHWEST or JCLegend.SOUTHEAST for vertical axes.

Returns:
one of NORTH or SOUTH for horizontal axes, and EAST/WEST/NORTHEAST/SOUTHEAST/NORTHWEST/SOUTHEAST for vertical axes.
 o setPlacementIsDefault
 public void setPlacementIsDefault(boolean pid)
Sets the value of the PlacementIsDefault property. The PlacementIsDefault property determines whether Chart is responsible for calculating a reasonable default placement for the axis title.

Parameters:
pid - true if the default placement is to be used, false otherwise.
 o getPlacementIsDefault
 public boolean getPlacementIsDefault()
Gets the value of the PlacementIsDefault property. The PlacementIsDefault property determines whether Chart is responsible for calculating a reasonable default placement for the axis title.

Returns:
true if the default placement is to be used, false otherwise.
 o saveParams
 public void saveParams(String name,
                        JCChart comp)
Save JCChart parameters as HTML tags

Parameters:
name - the PARAM NAME
chart - the JCChart component
Overrides:
saveParams in class ChartText
 o loadParams
 public void loadParams(String name,
                        JCChart comp)
Load JCChart parameters from HTML file

Parameters:
name - the PARAM NAME
chart - the JCChart component
Overrides:
loadParams in class ChartText

All Packages  Class Hierarchy  This Package  Previous  Next  Index