com.softwarefx.chartfx.server
Class LegendBox

java.lang.Object
  com.softwarefx.chartfx.server.DockableBar
      com.softwarefx.chartfx.server.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

ContentLayout	getContentLayout() Error: Member LegendBox.ContentLayout member not found
CustomLegendItemCollection	getCustomItems() Error: Member LegendBox.CustomItems member not found
Font	getFont() Gets the Font.
LegendItemAttributesCollection	getItemAttributes() Error: Member LegendBox.ItemAttributes member not found
int	getMarginX() Error: Member LegendBox.MarginX member not found
int	getMarginY() Error: Member LegendBox.MarginY member not found
EnumSet<LegendBoxStyles>	getStyle() Error: Member LegendBox.Style member not found
Color	getTextColor() Gets the TextColor.
TitleCollection	getTitles() Error: Member LegendBox.Titles member not found
boolean	isPlotAreaOnly() Error: Member LegendBox.PlotAreaOnly member not found
void	setContentLayout(ContentLayout value) Error: Member LegendBox.ContentLayout member not found
void	setFont(Font value) Sets the font type which will be used in the Legend Box.
void	setMarginX(int value) Error: Member LegendBox.MarginX member not found
void	setMarginY(int value) Error: Member LegendBox.MarginY member not found
void	setPlotAreaOnly(boolean value) Error: Member LegendBox.PlotAreaOnly member not found
void	setStyle(EnumSet<LegendBoxStyles> value) Error: Member LegendBox.Style member not found
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

getContentLayout

public ContentLayout getContentLayout()

Error: Member LegendBox.ContentLayout member not found

ERROR: Doc member not found

getCustomItems

public CustomLegendItemCollection getCustomItems()

Error: Member LegendBox.CustomItems member not found

ERROR: Doc member not found

getFont

public Font getFont()

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

getItemAttributes

public LegendItemAttributesCollection getItemAttributes()

Error: Member LegendBox.ItemAttributes member not found

ERROR: Doc member not found

getMarginX

public int getMarginX()

Error: Member LegendBox.MarginX member not found

ERROR: Doc member not found

getMarginY

public int getMarginY()

Error: Member LegendBox.MarginY member not found

ERROR: Doc member not found

getStyle

public EnumSet<LegendBoxStyles> getStyle()

Error: Member LegendBox.Style member not found

ERROR: Doc member not found

getTextColor

public Color getTextColor()

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

getTitles

public TitleCollection getTitles()

Error: Member LegendBox.Titles member not found

ERROR: Doc member not found

isPlotAreaOnly

public boolean isPlotAreaOnly()

Error: Member LegendBox.PlotAreaOnly member not found

ERROR: Doc member not found

setContentLayout

public void setContentLayout(ContentLayout value)

Error: Member LegendBox.ContentLayout member not found

ERROR: Doc member not found

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.

setMarginX

public void setMarginX(int value)

Error: Member LegendBox.MarginX member not found

ERROR: Doc member not found

setMarginY

public void setMarginY(int value)

Error: Member LegendBox.MarginY member not found

ERROR: Doc member not found

setPlotAreaOnly

public void setPlotAreaOnly(boolean value)

Error: Member LegendBox.PlotAreaOnly member not found

ERROR: Doc member not found

setStyle

public void setStyle(EnumSet<LegendBoxStyles> value)

Error: Member LegendBox.Style member not found

ERROR: Doc member not found

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.