com.softwarefx.chartfx.server
Class TitleDockable

java.lang.Object
  com.softwarefx.chartfx.server.Title
      com.softwarefx.chartfx.server.TitleDockable

public class TitleDockable
extends Title

Provides access to the TitleDockable object, and allows customization of the Titles of the chart.

The TitleDockable Class provides the developer with a means of controlling positioning and alignment for configured titles in a chart as well as visual attributes.

Using the supported members, you can adjust title strings to be center, near and fear as well as dock them in the right, left, top, or bottom of the chart.

To dock a title or use line alignment attributes, chart title objects must be created as a TitleDockable rather than a general Titleobject.

Constructor Summary

TitleDockable()

TitleDockable(String text)

Method Summary

DockArea	getDock() Gets the Dock.
boolean	isPlotAreaOnly() Gets the PlotAreaOnly.
void	setDock(DockArea value) Sets or Gets the Dock property, which sets the position where the title will be docked.
void	setPlotAreaOnly(boolean value) Sets a value indicating whether the title may use the entire length of the chart, or only above the plot area.

Methods inherited from class com.softwarefx.chartfx.server.Title

getAlignment, getBackColor, getFont, getIndentation, getLineAlignment, getLink, getSeparation, getText, getTextColor, isRichText, setAlignment, setBackColor, setFont, setIndentation, setLineAlignment, setRichText, setSeparation, setText, setTextColor

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TitleDockable

public TitleDockable()

TitleDockable

public TitleDockable(String text)

Method Detail

getDock

public DockArea getDock()

Gets the Dock. For more detail see setDock(com.softwarefx.chartfx.server.DockArea).

isPlotAreaOnly

public boolean isPlotAreaOnly()

Gets the PlotAreaOnly. For more detail see setPlotAreaOnly(boolean).

setDock

public void setDock(DockArea value)

Sets or Gets the Dock property, which sets the position where the title will be docked.

Remarks:

This property allows you to dock the chart title at the top, bottom, left or right of the chart.

Below is a title located at the top of the chart:

Alternatively, this is a title located at the right of the chart:

This is a title located at the left of the chart:

Finally, this is a title located at the bottom of the chart:

See Also:

Title.setAlignment(com.softwarefx.StringAlignment), Title.setLineAlignment(com.softwarefx.StringAlignment), Chart.getTitles(), Axis, Chart

setPlotAreaOnly

public void setPlotAreaOnly(boolean value)

Sets a value indicating whether the title may use the entire length of the chart, or only above the plot area.

Remarks:

When set to True, the title header is the same width as the chart's plot area. When set to False, title may be drawn across the entire chart including margins.

When using the Title.setAlignment(com.softwarefx.StringAlignment) property, the PlotAreaOnly property will affect the position of the text when configured to Near or Far.

See Also:

Title.setAlignment(com.softwarefx.StringAlignment), Title