com.softwarefx.chartfx.server.statistical

Class LegendBox

java.lang.Object

com.softwarefx.chartfx.server.DockableBar

com.softwarefx.chartfx.server.statistical.LegendBox

public final 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

Constructors

Constructor and Description
LegendBox() Constructs a newly allocated LegendBox object

Method Summary

Methods

Modifier and Type	Method and Description
void	dispose() Releases all resources allocated to the LegendBox object.
java.awt.Font	getFont() Gets or sets the font type which will be used in the Legend Box.
java.awt.Color	getTextColor() Gets or sets the text color for the legend box.
boolean	isShowValues() Get or set the boolean to show values in the legend box.
void	resetScrollPosition() Set the property ScrollPosition to its default value.
void	resetShowValues() Set the property ShowValues to its default value.
void	resetTextColor() Set the property TextColor to its default value.
void	setFont(java.awt.Font value) Gets or 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(java.awt.Color value) Gets or 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

addVisibleChangedListener, getBackColor, getBorder, getDock, getHeight, getWidth, getZOrder, isAutoSize, isVisible, removeVisibleChangedListener, resetAutoSize, resetBackColor, resetBorder, resetDock, resetHeight, resetVisible, resetWidth, resetZOrder, 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()

Constructs a newly allocated LegendBox object

Method Detail

getFont

public java.awt.Font getFont()

Gets or sets the font type which will be used in the Legend Box.

For more information on the Font class refer to the Java documentation.

setFont

public void setFont(java.awt.Font value)

Gets or sets the font type which will be used in the Legend Box.

For more information on the Font class refer to the Java documentation.

Parameters:

value -

isShowValues

public boolean isShowValues()

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

Values will only be shown for certain Studies.

Enable showing values.

See Also:

resetShowValues

setShowValues

public void setShowValues(boolean value)

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

Values will only be shown for certain Studies.

Enable showing values.

Parameters:

value -

See Also:

resetShowValues

getTextColor

public java.awt.Color getTextColor()

Gets or sets the text color for the legend box.

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

See Also:

resetTextColor

setTextColor

public void setTextColor(java.awt.Color value)

Gets or sets the text color for the legend box.

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

Parameters:

value -

See Also:

resetTextColor

dispose

public void dispose()

Releases all resources allocated to the LegendBox object.

For more information on garbage collection refer to the Java documentation.

resetScrollPosition

public void resetScrollPosition()

Set the property ScrollPosition to its default value.

resetShowValues

public void resetShowValues()

Set the property ShowValues to its default value.

See Also:

isShowValues

resetTextColor

public void resetTextColor()

Set the property TextColor to its default value.

See Also:

setTextColor

sizeToFit

public void sizeToFit()

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

This method is particularly useful when the isAutoSize method (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 method to true.