com.softwarefx.chartfx.server.statistical
Class LegendBox

java.lang.Object
  com.softwarefx.chartfx.server.DockableBar
      com.softwarefx.chartfx.server.statistical.LegendBox

public class LegendBox
extends DockableBar

Provides access to the LegendBox object.

The statistical legend is not only used to display statistical analysis values, but also allows your end users to interact with any interactive studies applied to the chart. The supported members of this class allow you to apply visual attributes to the statistical legend.

Constructor Summary

LegendBox()

Method Summary

void	dispose() Releases all resources allocated to the LegendBox object.
Font	getFont() Gets the Font.
Color	getTextColor() Gets the TextColor.
boolean	isShowValues() Gets the ShowValues.
void	setFont(Font value) Sets the font type which will be used in the Legend Box.
void	setShowValues(boolean value) Get or set the boolean to show values in the legend box.
void	setTextColor(Color value) Sets the text color for the legend box.
void	sizeToFit() Calculates and sets the best-fit size for the legend box.

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

getBackColor, getBorder, getDock, getHeight, getWidth, getZOrder, isAutoSize, isVisible, resetBackColor, setAutoSize, setBackColor, setBorder, setDock, setHeight, setVisible, setWidth, setZOrder

Methods inherited from class java.lang.Object

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

Constructor Detail

LegendBox

public LegendBox()

Method Detail

dispose

public void dispose()

Releases all resources allocated to the LegendBox object.

Remarks:

getFont

public Font getFont()

Gets the Font. For more detail see setFont(java.awt.Font).

getTextColor

public Color getTextColor()

Gets the TextColor. For more detail see setTextColor(java.awt.Color).

isShowValues

public boolean isShowValues()

Gets the ShowValues. For more detail see setShowValues(boolean).

setFont

public void setFont(Font value)

Sets the font type which will be used in the Legend Box.

Remarks:

For more information on the Font class refer to the java.awt.Font Documentation.

setShowValues

public void setShowValues(boolean value)

Get or set the boolean to show values in the legend box.

Remarks:

Values will only be shown for certain Studies.

See Also:

Study

setTextColor

public void setTextColor(Color value)

Sets the text color for the legend box.

Remarks:

For more information regarding the Color type, please refer to your development environment documentation.

sizeToFit

public void sizeToFit()

Calculates and sets the best-fit size for the legend box.

Remarks:

This method is particularly useful when the AutoSize property (of the DockableBar class) is set to False, as it will allow you to recalculate the best-fit size for the selected tool without setting the AutoSize property to True.