org.wicketstuff.jqplot.lib.elements

Class Legend

java.lang.Object

org.wicketstuff.jqplot.lib.elements.Legend

All Implemented Interfaces:

Serializable, Element

public class Legend
extends Object
implements Element

Legend object. Legend properties can be set or overriden by the options passed in from the user.

Author:

inaiat

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Legend() Instantiates a new legend.
Legend(boolean show, Location location) Instantiates a new legend.
Legend(String options) Instantiates a new legend.

Method Summary

Modifier and Type	Method and Description
String	getBackground() Gets the background.
String	getBorder() Gets the border.
Boolean	getEscapeHtml() Gets the escape html.
String	getFontFamily() Gets the font family.
String[]	getLables() Gets the lables.
Location	getLocation() Gets the location.
String	getMarginBottom() Gets the margin bottom.
String	getMarginLeft() Gets the margin left.
String	getMarginRight() Gets the margin right.
String	getMarginTop() Gets the margin top.
String	getOptions() Gets the options.
String	getPlacement() Gets the placement.
Boolean	getPreDraw() Gets the pre draw.
JqPlotResources	getRenderer() Gets the renderer.
LegendRenderer	getRendererOptions() Gets the RendererOptions
Boolean	getShow() Gets the show.
Boolean	getShowLables() Gets the show lables.
Boolean	getShowSwatches() Gets the show swatches.
Double	getXoffset() Gets the xoffset.
Double	getYoffset() Gets the yoffset.
void	setBackground(String background) Sets the background.
void	setBorder(String border) Sets the border.
void	setEscapeHtml(Boolean escapeHtml) Sets the escape html.
void	setFontFamily(String fontFamily) Sets the font family.
void	setLables(String[] lables) Sets the lables.
void	setLocation(Location location) Sets the location.
void	setMarginBottom(String marginBottom) Sets the margin bottom.
void	setMarginLeft(String marginLeft) Sets the margin left.
void	setMarginRight(String marginRight) Sets the margin right.
void	setMarginTop(String marginTop) Sets the margin top.
void	setOptions(String options) Sets the options.
void	setPlacement(String placement) Sets the placement.
void	setPreDraw(Boolean preDraw) Sets the pre draw.
void	setRenderer(JqPlotResources renderer) Sets the renderer.
void	setRendererOptions(LegendRenderer rendererOptions) Sets the RendererOptions
void	setShow(Boolean show) Sets the show.
void	setShowLables(Boolean showLables) Sets the show lables.
void	setShowSwatches(Boolean showSwatches) Sets the show swatches.
void	setXoffset(Double xoffset) Sets the xoffset.
void	setYoffset(Double yoffset) Sets the yoffset.

Methods inherited from class java.lang.Object

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

Constructor Detail

Legend

public Legend()

Instantiates a new legend.

Legend

public Legend(boolean show,
              Location location)

Instantiates a new legend.

Parameters:

show - the show

location - the location

Legend

public Legend(String options)

Instantiates a new legend.

Parameters:

options - the options

Method Detail

getBackground

public String getBackground()

Gets the background.

Returns:

the background

setBackground

public void setBackground(String background)

Sets the background.

Parameters:

background - the new background

getBorder

public String getBorder()

Gets the border.

Returns:

the border

setBorder

public void setBorder(String border)

Sets the border.

Parameters:

border - the new border

getEscapeHtml

public Boolean getEscapeHtml()

Gets the escape html.

Returns:

the escape html

setEscapeHtml

public void setEscapeHtml(Boolean escapeHtml)

Sets the escape html.

Parameters:

escapeHtml - the new escape html

getFontFamily

public String getFontFamily()

Gets the font family.

Returns:

the font family

setFontFamily

public void setFontFamily(String fontFamily)

Sets the font family.

Parameters:

fontFamily - the new font family

getLables

public String[] getLables()

Gets the lables.

Returns:

the lables

setLables

public void setLables(String[] lables)

Sets the lables.

Parameters:

lables - the new lables

getLocation

public Location getLocation()

Gets the location.

Returns:

the location

setLocation

public void setLocation(Location location)

Sets the location.

Parameters:

location - the new location

getMarginBottom

public String getMarginBottom()

Gets the margin bottom.

Returns:

the margin bottom

setMarginBottom

public void setMarginBottom(String marginBottom)

Sets the margin bottom.

Parameters:

marginBottom - the new margin bottom

getMarginLeft

public String getMarginLeft()

Gets the margin left.

Returns:

the margin left

setMarginLeft

public void setMarginLeft(String marginLeft)

Sets the margin left.

Parameters:

marginLeft - the new margin left

getMarginRight

public String getMarginRight()

Gets the margin right.

Returns:

the margin right

setMarginRight

public void setMarginRight(String marginRight)

Sets the margin right.

Parameters:

marginRight - the new margin right

getMarginTop

public String getMarginTop()

Gets the margin top.

Returns:

the margin top

setMarginTop

public void setMarginTop(String marginTop)

Sets the margin top.

Parameters:

marginTop - the new margin top

getPlacement

public String getPlacement()

Gets the placement.

Returns:

the placement

setPlacement

public void setPlacement(String placement)

Sets the placement.

Parameters:

placement - the new placement

getPreDraw

public Boolean getPreDraw()

Gets the pre draw.

Returns:

the pre draw

setPreDraw

public void setPreDraw(Boolean preDraw)

Sets the pre draw.

Parameters:

preDraw - the new pre draw

getRenderer

public JqPlotResources getRenderer()

Gets the renderer.

Returns:

the renderer

setRenderer

public void setRenderer(JqPlotResources renderer)

Sets the renderer.

Parameters:

renderer - the new renderer

getShow

public Boolean getShow()

Gets the show.

Returns:

the show

setShow

public void setShow(Boolean show)

Sets the show.

Parameters:

show - the new show

getShowLables

public Boolean getShowLables()

Gets the show lables.

Returns:

the show lables

setShowLables

public void setShowLables(Boolean showLables)

Sets the show lables.

Parameters:

showLables - the new show lables

getShowSwatches

public Boolean getShowSwatches()

Gets the show swatches.

Returns:

the show swatches

setShowSwatches

public void setShowSwatches(Boolean showSwatches)

Sets the show swatches.

Parameters:

showSwatches - the new show swatches

getXoffset

public Double getXoffset()

Gets the xoffset.

Returns:

the xoffset

setXoffset

public void setXoffset(Double xoffset)

Sets the xoffset.

Parameters:

xoffset - the new xoffset

getYoffset

public Double getYoffset()

Gets the yoffset.

Returns:

the yoffset

setYoffset

public void setYoffset(Double yoffset)

Sets the yoffset.

Parameters:

yoffset - the new yoffset

getOptions

public String getOptions()

Gets the options.

Returns:

the options

setOptions

public void setOptions(String options)

Sets the options.

Parameters:

options - the new options

getRendererOptions

public LegendRenderer getRendererOptions()

Gets the RendererOptions

Returns:

LegendRenderer

setRendererOptions

public void setRendererOptions(LegendRenderer rendererOptions)

Sets the RendererOptions

Parameters:

rendererOptions - set the LegendRenderer