com.cete.dynamicpdf.pageelements.charting
Class Legend

java.lang.Object
  com.cete.dynamicpdf.pageelements.charting.Legend

public class Legend
extends java.lang.Object

Represents a Legend.

Licensing:
This is a DynamicPDF Generator Enterprise Edition feature. One of the following licenses is required for non-evaluation usage:

• DynamicPDF Generator Enterprise Edition
• DynamicPDF Merger Enterprise Edition

View Example

Method Summary

TextAlign	getAlign() Gets the legend labels text alignment.
Color	getBackgroundColor() Gets the background color of the Legend.
Color	getBorderColor() Gets the border color of the Legend.
float	getBottomPadding() Gets the bottom padding of the Legend.
Font	getFont() Gets the Font of the Legend.
float	getFontSize() Gets the font size of the Legend.
float	getHeight() Gets the height of the legend.
float	getLabelSpacing() Gets the label spacing of the legend.
float	getLeftPadding() Gets the left padding of the Legend.
LegendLabelList	getLegendLabelList() Gets the legend label list from the Legend.
LineStyle	getLineStyle() Gets the LineStyle of the legend.
float	getLineWidth() Gets the line width of the legend.
float	getRequiredHeight() Gets the Height required to draw the legend.
float	getRequiredWidth() Gets the Width required to draw the legend.
float	getRightPadding() Gets the right padding of the legend.
float	getSymbolSpacing() Gets the symbol spacing of the legend.
Color	getTextColor() Gets the text color of the Legend.
float	getTopPadding() Gets the top padding of the legend.
boolean	getVisible() Gets the visible property of the legend.
float	getWidth() Gets the width of the legend.
float	getX() Gets the x position of the legend.
float	getY() Gets the y position of the legend.
void	setAlign(TextAlign textAlign) Sets the legend labels text alignment.
void	setBackgroundColor(Color color) Sets the background color of the Legend.
void	setBorderColor(Color color) Sets the border color of the Legend.
void	setBottomPadding(float bottomPadding) Sets the bottom padding of the legend.
void	setFont(Font font) Sets the Font of the legend.
void	setFontSize(float fontSize) Sets the font size of the Legend.
void	setHeight(float height) Sets the Height of the legend.
void	setLabelSpacing(float labelSpacing) Sets the label spacing of the legend.
void	setLeftPadding(float leftPadding) Sets the left padding of the Legend.
void	setLineStyle(LineStyle style) Sets the LineStyle of the legend.
void	setLineWidth(float width) Sets the line width of the legend.
void	setRightPadding(float rightPadding) Sets the right padding of the legend.
void	setSymbolSpacing(float symbolSpacing) Sets the symbol spacing of the lLegend.
void	setTextColor(Color color) Sets the text color of the Legend.
void	setTopPadding(float topPadding) Sets the top padding of the legend.
void	setVisible(boolean value) Sets the visible property of the legend.
void	setWidth(float width) Sets the width of the Legend.
void	setX(float x) Sets the x position of the legend.
void	setY(float y) Sets the y position of the legend.

Methods inherited from class java.lang.Object

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

Method Detail

setFont

public void setFont(Font font)

Sets the Font of the legend.

Parameters:

font - The font of the legend.

See Also:

Font

getAlign

public TextAlign getAlign()

Gets the legend labels text alignment.

Returns:

TextAlign The legend labels text alignment.

setAlign

public void setAlign(TextAlign textAlign)

Sets the legend labels text alignment.

Parameters:

textAlign - the legend labels text alignment

getFont

public Font getFont()

Gets the Font of the Legend.

Returns:

Font The font of the legend.

See Also:

Font

setFontSize

public void setFontSize(float fontSize)

Sets the font size of the Legend.

Parameters:

fontSize - The fontsize of the legend.

getFontSize

public float getFontSize()

Gets the font size of the Legend.

Returns:

float The font size of the Legend.

setTextColor

public void setTextColor(Color color)

Sets the text color of the Legend.

Parameters:

color - The Color of the Legend Text.

See Also:

Color

getTextColor

public Color getTextColor()

Gets the text color of the Legend.

Returns:

Color The Color of the Legend Text.

See Also:

Color

setBorderColor

public void setBorderColor(Color color)

Sets the border color of the Legend.

Parameters:

color - The border Color of the legend.

See Also:

Color

getBorderColor

public Color getBorderColor()

Gets the border color of the Legend.

Returns:

Color The borderColor of the legend.

See Also:

Color

setBackgroundColor

public void setBackgroundColor(Color color)

Sets the background color of the Legend.

Parameters:

color - The background Color of the legend.

See Also:

Color

getBackgroundColor

public Color getBackgroundColor()

Gets the background color of the Legend.

Returns:

Color The backgroundColor of the legend.

See Also:

Color

getLegendLabelList

public LegendLabelList getLegendLabelList()

Gets the legend label list from the Legend.

Returns:

LegendLabelList The legend label list of the legend.

See Also:

LegendLabelList

getRequiredWidth

public float getRequiredWidth()

Gets the Width required to draw the legend.

Returns:

float The required width of the legend.

setTopPadding

public void setTopPadding(float topPadding)

Sets the top padding of the legend.

Parameters:

topPadding - The top padding of the legend.

getTopPadding

public float getTopPadding()

Gets the top padding of the legend.

Returns:

float The top padding of the legend.

setBottomPadding

public void setBottomPadding(float bottomPadding)

Sets the bottom padding of the legend.

Parameters:

bottomPadding - The bottom padding of the legend.

getBottomPadding

public float getBottomPadding()

Gets the bottom padding of the Legend.

Returns:

float The bottom padding of the legend.

setLeftPadding

public void setLeftPadding(float leftPadding)

Sets the left padding of the Legend.

Parameters:

leftPadding - The left padding of the legend.

getLeftPadding

public float getLeftPadding()

Gets the left padding of the Legend.

Returns:

float The left padding of the legend.

setRightPadding

public void setRightPadding(float rightPadding)

Sets the right padding of the legend.

Parameters:

rightPadding - The right padding of the legend.

getRightPadding

public float getRightPadding()

Gets the right padding of the legend.

Returns:

float The right padding of the legend.

setLabelSpacing

public void setLabelSpacing(float labelSpacing)

Sets the label spacing of the legend.

Parameters:

labelSpacing - The label spacing of the legend.

getLabelSpacing

public float getLabelSpacing()

Gets the label spacing of the legend.

Returns:

float The label spacing of the legend.

setSymbolSpacing

public void setSymbolSpacing(float symbolSpacing)

Sets the symbol spacing of the lLegend.

Parameters:

symbolSpacing - The symbol spacing of the legend.

getSymbolSpacing

public float getSymbolSpacing()

Gets the symbol spacing of the legend.

Returns:

float The symbol spacing of the legend.

setVisible

public void setVisible(boolean value)

Sets the visible property of the legend.

Parameters:

value - The visible property of the legend.

getVisible

public boolean getVisible()

Gets the visible property of the legend.

Returns:

boolean The visible property of the legend.

setX

public void setX(float x)

Sets the x position of the legend.

Parameters:

x - The x position of the legend.

getX

public float getX()

Gets the x position of the legend.

Returns:

float The x position of the legend.

getY

public float getY()

Gets the y position of the legend.

Returns:

float The y position of the legend.

setY

public void setY(float y)

Sets the y position of the legend.

Parameters:

y - The y position of the legend.

getLineWidth

public float getLineWidth()

Gets the line width of the legend.

Returns:

float The line width of the lLegend.

setLineWidth

public void setLineWidth(float width)

Sets the line width of the legend.

Parameters:

width - The line width of the legend.

setLineStyle

public void setLineStyle(LineStyle style)

Sets the LineStyle of the legend.

Parameters:

style - The lineStyle of the legend.

See Also:

LineStyle

getLineStyle

public LineStyle getLineStyle()

Gets the LineStyle of the legend.

Returns:

LineStyle The lineStyle of the legend.

setWidth

public void setWidth(float width)

Sets the width of the Legend.

Parameters:

width - The width of the Legend.

getWidth

public float getWidth()

Gets the width of the legend.

Returns:

float The width of the legend.

getHeight

public float getHeight()

Gets the height of the legend.

Returns:

float The height of the legend.

setHeight

public void setHeight(float height)

Sets the Height of the legend.

Parameters:

height - The Height of the legend.

getRequiredHeight

public float getRequiredHeight()

Gets the Height required to draw the legend.

Returns:

float The required Height of the legend.