public class LegendSymbol extends TeeBase
Title: LegendSymbol class
Description: Legend item symbol characteristics
Copyright (c) 2005-2019 by Steema Software SL. All Rights Reserved.
Company: Steema Software SL
Modifier and Type | Field and Description |
---|---|
protected boolean |
continuous
Determines if legend symbol should display without separation from other
legend item symbols.
|
protected Legend |
legend
Internal field pointing to parent legend class
|
protected LegendSymbolPosition |
position
Controls where to display the legend symbol related to symbol item.
|
chart, InternalUse
Constructor and Description |
---|
LegendSymbol(Legend legend) |
Modifier and Type | Method and Description |
---|---|
protected int |
calcWidth(int value) |
protected void |
draw(Rectangle r) |
protected void |
draw(Rectangle R,
IGraphics3D tmp) |
boolean |
getContinuous()
Adjoins the different legend color rectangles when true.
The color rectangles of the different items are drawn attached to each other (no vertical spacing). |
boolean |
getDefaultPen()
Uses series pen properties to draw a border around the coloured box
legend symbol, when true.
|
int |
getLineWidth()
Defines the width of the Line used to plot Line symbols when wishing to
override the default line width associated with the Series.
|
ChartPen |
getPen()
pen used to draw a border around the color box legend symbols.
|
LegendSymbolPosition |
getPosition()
The position of the Legend color rectangles.
|
boolean |
getSquared()
Resizes the legend symbol to square shaped, when true.
When false, the legend symbol height is determined by the legend font size, and the symbol width is calculated using the Width and WidthUnits properties. Default value: false |
boolean |
getVisible()
Shows or hides Legend symbols.
Default value: true |
int |
getWidth()
Defines the width of the color rectangles (symbols).
Default value: 20 |
LegendSymbolSize |
getWidthUnits()
Defines the Width units for the width of Symbol.
- Percent is percentage of Legend box width - Pixels is the width in standard pixels Default value: Percent |
protected java.lang.Object |
readResolve() |
void |
setContinuous(boolean value)
Adjoins the different legend color rectangles when true.
Default value: false |
void |
setDefaultPen(boolean value)
Uses series pen properties to draw a border around the coloured box
legend symbol, when true.
|
void |
setLineWidth(int value) |
void |
setPosition(LegendSymbolPosition value)
Sets the position of the Legend color rectangles.
|
void |
setSquared(boolean value)
Resizes the legend symbol to square shaped, when true.
|
void |
setVisible(boolean value)
Shows or hides Legend symbols.
Default value: true |
void |
setWidth(int value) |
void |
setWidthUnits(LegendSymbolSize value)
Sets the Width units for the width of Symbol.
Default value: Percent |
getChart, invalidate, setBooleanProperty, setChart, setColorProperty, setDoubleProperty, setIntegerProperty, setStringProperty
protected boolean continuous
protected LegendSymbolPosition position
protected transient Legend legend
public LegendSymbol(Legend legend)
protected java.lang.Object readResolve()
public int getWidth()
public void setWidth(int value)
public int getLineWidth()
public void setLineWidth(int value)
public LegendSymbolPosition getPosition()
public void setPosition(LegendSymbolPosition value)
value
- LegendSymbolPositionpublic LegendSymbolSize getWidthUnits()
public void setWidthUnits(LegendSymbolSize value)
value
- LegendSymbolSizepublic boolean getContinuous()
public void setContinuous(boolean value)
value
- booleanpublic boolean getDefaultPen()
public void setDefaultPen(boolean value)
value
- booleanprotected int calcWidth(int value)
public ChartPen getPen()
public boolean getSquared()
public void setSquared(boolean value)
value
- booleanpublic boolean getVisible()
public void setVisible(boolean value)
value
- booleanprotected void draw(Rectangle r)
protected void draw(Rectangle R, IGraphics3D tmp)