java.lang.Object
- org.meteoinfo.chart.ChartLegend

Direct Known Subclasses:: ChartColorBar

public class ChartLegend
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`class`	`ChartLegend.LayoutLegendBean`
`static class`	`ChartLegend.LayoutLegendBeanBeanInfo`
`static class`	`ChartLegend.PlotOrientationEditor`

Field Summary

Fields
Modifier and Type	Field	Description
`protected float`	`_hBarHeight`
`protected float`	`_vBarWidth`
`protected int`	`aspect`
`protected boolean`	`autoExtendFrac`
`protected java.awt.Color`	`background`
`protected boolean`	`drawBackground`
`protected boolean`	`drawMaxLabel`
`protected boolean`	`drawMinLabel`
`protected boolean`	`drawNeatLine`
`protected boolean`	`extendRect`
`protected int`	`height`
`protected ChartText`	`label`
`protected java.lang.String`	`labelLocation`
`protected int`	`legendHeight`
`protected LegendScheme`	`legendScheme`
`protected int`	`legendWidth`
`protected java.awt.Color`	`neatLineColor`
`protected float`	`neatLineSize`
`protected PlotOrientation`	`orientation`
`protected float`	`shrink`
`protected float`	`tickLabelAngle`
`protected java.awt.Color`	`tickLabelColor`
`protected java.awt.Font`	`tickLabelFont`
`protected int`	`width`
`protected float`	`x`
`protected float`	`xshift`
`protected float`	`y`
`protected float`	`yshift`

Constructor Summary

Constructors
Constructor Description

ChartLegend(LegendScheme ls)
Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`draw(java.awt.Graphics2D g, PointF point)`	Draw legend
`int`	`getAspect()`	Get aspect
`java.awt.Color`	`getBackground()`	Get background
`int`	`getColumnNumber()`	Get column number
`int`	`getHeight()`	Get height
`ChartText`	`getLabel()`	Get label
`java.awt.Color`	`getLabelColor()`	Get label color
`java.awt.Font`	`getLabelFont()`	Get label font
`java.lang.String`	`getLabelLocation()`	Get label location (in, out, top, bottom, left, right)
`java.awt.Dimension`	`getLegendDimension(java.awt.Graphics2D g, java.awt.Dimension limitDim)`	Get legend dimension
`int`	`getLegendHeight()`	Get legend height
`LegendScheme`	`getLegendScheme()`	Get legend scheme
`int`	`getLegendWidth()`	Get legend width
`java.awt.Color`	`getNeatLineColor()`	Get neat line color
`float`	`getNeatLineSize()`	Get neat line size
`PlotOrientation`	`getPlotOrientation()`	Get plot orientation
`LegendPosition`	`getPosition()`	Get legend position
`float`	`getShrink()`	Get shrink
`java.awt.Dimension`	`getSymbolDimension()`	Get symbol dimension
`protected int`	`getTickGap(java.awt.Graphics2D g)`	Update tick gap
`protected int`	`getTickHeight(java.awt.Graphics2D g)`
`float`	`getTickLabelAngle()`	Get tick lable angle
`java.awt.Color`	`getTickLabelColor()`	Get tick label color
`java.awt.Font`	`getTickLabelFont()`	Get Tick label font
`protected int`	`getTickWidth(java.awt.Graphics2D g)`
`int`	`getWidth()`	Get width
`float`	`getX()`	Get X
`float`	`getXShift()`	Get x shift - pixel unit
`float`	`getY()`	Get Y
`float`	`getYShift()`	Get y shift - pixel unit
`boolean`	`isAutoExtendFrac()`	Get if auto set extend fraction - extend has save width and height Only valid for colorbar
`boolean`	`isAutoRowColNum()`	Get if automatic set row/col number
`boolean`	`isColorbar()`	Get if is color bar
`boolean`	`isDrawBackground()`	Get if draw background
`boolean`	`isDrawMaxLabel()`	Get if draw maximum value label
`boolean`	`isDrawMinLabel()`	Get if draw minimum value label
`boolean`	`isDrawNeatLine()`	Get if draw neat line
`boolean`	`isExtendRect()`	Get if extend rectangle - or triangle
`void`	`setAspect(int value)`	Set aspect
`void`	`setAutoExtendFrac(boolean value)`	Set if auto set extend fraction - extend has save width and height Only valid for colorbar
`void`	`setAutoRowColNum(boolean value)`	Set if automatic set row/col number
`void`	`setBackground(java.awt.Color value)`	Set background
`void`	`setColorbar(boolean value)`	Set if is color bar
`void`	`setColumnNumber(int value)`	Set column number
`void`	`setDrawBackground(boolean value)`	Set if draw background
`void`	`setDrawMaxLabel(boolean value)`	Set if draw maximum value label
`void`	`setDrawMinLabel(boolean value)`	Set if draw minimum value label
`void`	`setDrawNeatLine(boolean istrue)`	Set if draw neat line
`void`	`setExtendRect(boolean value)`	Set if extend rectangle - or triangle
`void`	`setHeight(int value)`	Set height
`void`	`setLabel(ChartText value)`	Set label
`void`	`setLabelColor(java.awt.Color value)`	Set label color
`void`	`setLabelFont(java.awt.Font value)`	Set label font
`void`	`setLabelLocation(java.lang.String value)`	Set label location
`void`	`setLegendHeight(int value)`	Set legend height
`void`	`setLegendScheme(LegendScheme value)`	Set legend scheme
`void`	`setLegendWidth(int value)`	Set legend width
`void`	`setNeatLineColor(java.awt.Color color)`	Set neat line color
`void`	`setNeatLineSize(float size)`	Set neat line size
`void`	`setPlotOrientation(PlotOrientation value)`	Set plot orientation
`void`	`setPosition(LegendPosition value)`	Set legend position
`void`	`setShrink(float value)`	Set shrink
`void`	`setSymbolDimension(java.awt.Dimension value)`	Set symbol dimension
`void`	`setSymbolHeight(int value)`	Set symbol height
`void`	`setSymbolScale(float value)`	Set symbol scale
`void`	`setSymbolWidth(int value)`	Set symbol width
`void`	`setTickCaptions(java.util.List<java.lang.String> value)`	Set tick labels
`void`	`setTickLabelAngle(float value)`	Set tick label angle
`void`	`setTickLabelColor(java.awt.Color value)`	Set tick label color
`void`	`setTickLabelFont(java.awt.Font font)`	Set Tick label font
`void`	`setWidth(int value)`	Set width
`void`	`setX(float value)`	Set X
`void`	`setXShift(float value)`	Set x shift
`void`	`setY(float value)`	Set Y
`void`	`setYShift(float value)`	Set y shift

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - legendScheme
```
protected LegendScheme legendScheme
```
  - shrink
```
protected float shrink
```
  - aspect
```
protected int aspect
```
  - x
```
protected float x
```
  - y
```
protected float y
```
  - orientation
```
protected PlotOrientation orientation
```
  - background
```
protected java.awt.Color background
```
  - drawBackground
```
protected boolean drawBackground
```
  - width
```
protected int width
```
  - height
```
protected int height
```
  - legendWidth
```
protected int legendWidth
```
  - legendHeight
```
protected int legendHeight
```
  - label
```
protected ChartText label
```
  - labelLocation
```
protected java.lang.String labelLocation
```
  - tickLabelFont
```
protected java.awt.Font tickLabelFont
```
  - tickLabelColor
```
protected java.awt.Color tickLabelColor
```
  - tickLabelAngle
```
protected float tickLabelAngle
```
  - drawNeatLine
```
protected boolean drawNeatLine
```
  - neatLineColor
```
protected java.awt.Color neatLineColor
```
  - neatLineSize
```
protected float neatLineSize
```
  - _vBarWidth
```
protected float _vBarWidth
```
  - _hBarHeight
```
protected float _hBarHeight
```
  - extendRect
```
protected boolean extendRect
```
  - autoExtendFrac
```
protected boolean autoExtendFrac
```
  - drawMinLabel
```
protected boolean drawMinLabel
```
  - drawMaxLabel
```
protected boolean drawMaxLabel
```
  - xshift
```
protected float xshift
```
  - yshift
```
protected float yshift
```
- Constructor Detail
  - ChartLegend
```
public ChartLegend(LegendScheme ls)
```
    Constructor
    
    Parameters:
    
    ls - LegendScheme
- Method Detail
  - getLegendScheme
```
public LegendScheme getLegendScheme()
```
    Get legend scheme
    
    Returns:
    
    Legend scheme
  - setLegendScheme
```
public void setLegendScheme(LegendScheme value)
```
    Set legend scheme
    
    Parameters:
    
    value - Legend scheme
  - isColorbar
```
public boolean isColorbar()
```
    Get if is color bar
    
    Returns:
    
    Boolean
  - setColorbar
```
public void setColorbar(boolean value)
```
    Set if is color bar
    
    Parameters:
    
    value - Boolean
  - getPosition
```
public LegendPosition getPosition()
```
    Get legend position
    
    Returns:
    
    Legend position
  - setPosition
```
public void setPosition(LegendPosition value)
```
    Set legend position
    
    Parameters:
    
    value - Legend position
  - getShrink
```
public float getShrink()
```
    Get shrink
    
    Returns:
    
    Shrink
  - setShrink
```
public void setShrink(float value)
```
    Set shrink
    
    Parameters:
    
    value - Shrink
  - getAspect
```
public int getAspect()
```
    Get aspect
    
    Returns:
    
    Aspect
  - setAspect
```
public void setAspect(int value)
```
    Set aspect
    
    Parameters:
    
    value - Aspect
  - getX
```
public float getX()
```
    Get X
    
    Returns:
    
    X value
  - setX
```
public void setX(float value)
```
    Set X
    
    Parameters:
    
    value - X value
  - getY
```
public float getY()
```
    Get Y
    
    Returns:
    
    Y value
  - setY
```
public void setY(float value)
```
    Set Y
    
    Parameters:
    
    value - Y value
  - getWidth
```
public int getWidth()
```
    Get width
    
    Returns:
    
    Width
  - setWidth
```
public void setWidth(int value)
```
    Set width
    
    Parameters:
    
    value - Width
  - getHeight
```
public int getHeight()
```
    Get height
    
    Returns:
    
    Height
  - setHeight
```
public void setHeight(int value)
```
    Set height
    
    Parameters:
    
    value - Height
  - getLegendWidth
```
public int getLegendWidth()
```
    Get legend width
    
    Returns:
    
    Legend width
  - setLegendWidth
```
public void setLegendWidth(int value)
```
    Set legend width
    
    Parameters:
    
    value - Legend width
  - getLegendHeight
```
public int getLegendHeight()
```
    Get legend height
    
    Returns:
    
    Legend height
  - setLegendHeight
```
public void setLegendHeight(int value)
```
    Set legend height
    
    Parameters:
    
    value - Legend height
  - getPlotOrientation
```
public PlotOrientation getPlotOrientation()
```
    Get plot orientation
    
    Returns:
    
    Plot orientation
  - setPlotOrientation
```
public void setPlotOrientation(PlotOrientation value)
```
    Set plot orientation
    
    Parameters:
    
    value - Plot orientation
  - getBackground
```
public java.awt.Color getBackground()
```
    Get background
    
    Returns:
    
    Background
  - setBackground
```
public void setBackground(java.awt.Color value)
```
    Set background
    
    Parameters:
    
    value - Background
  - isDrawBackground
```
public boolean isDrawBackground()
```
    Get if draw background
    
    Returns:
    
    Boolean
  - setDrawBackground
```
public void setDrawBackground(boolean value)
```
    Set if draw background
    
    Parameters:
    
    value - Boolean
  - isDrawNeatLine
```
public boolean isDrawNeatLine()
```
    Get if draw neat line
    
    Returns:
    
    If draw neat line
  - setDrawNeatLine
```
public void setDrawNeatLine(boolean istrue)
```
    Set if draw neat line
    
    Parameters:
    
    istrue - If draw neat line
  - getNeatLineColor
```
public java.awt.Color getNeatLineColor()
```
    Get neat line color
    
    Returns:
    
    Neat line color
  - setNeatLineColor
```
public void setNeatLineColor(java.awt.Color color)
```
    Set neat line color
    
    Parameters:
    
    color - Neat line color
  - getNeatLineSize
```
public float getNeatLineSize()
```
    Get neat line size
    
    Returns:
    
    Neat line size
  - setNeatLineSize
```
public void setNeatLineSize(float size)
```
    Set neat line size
    
    Parameters:
    
    size - Neat line size
  - getLabel
```
public ChartText getLabel()
```
    Get label
    
    Returns:
    
    Label
  - setLabel
```
public void setLabel(ChartText value)
```
    Set label
    
    Parameters:
    
    value - Label
  - getLabelFont
```
public java.awt.Font getLabelFont()
```
    Get label font
    
    Returns:
    
    Label font
  - setLabelFont
```
public void setLabelFont(java.awt.Font value)
```
    Set label font
    
    Parameters:
    
    value - Label font
  - getLabelColor
```
public java.awt.Color getLabelColor()
```
    Get label color
    
    Returns:
    
    Label color
  - setLabelColor
```
public void setLabelColor(java.awt.Color value)
```
    Set label color
    
    Parameters:
    
    value - Label color
  - getLabelLocation
```
public java.lang.String getLabelLocation()
```
    Get label location (in, out, top, bottom, left, right)
    
    Returns:
    
    Label location
  - setLabelLocation
```
public void setLabelLocation(java.lang.String value)
```
    Set label location
    
    Parameters:
    
    value - Label location
  - getTickLabelFont
```
public java.awt.Font getTickLabelFont()
```
    Get Tick label font
    
    Returns:
    
    The Tick label font
  - setTickLabelFont
```
public void setTickLabelFont(java.awt.Font font)
```
    Set Tick label font
    
    Parameters:
    
    font - The Tick label font
  - getTickLabelColor
```
public java.awt.Color getTickLabelColor()
```
    Get tick label color
    
    Returns:
    
    Tick label color
  - setTickLabelColor
```
public void setTickLabelColor(java.awt.Color value)
```
    Set tick label color
    
    Parameters:
    
    value - Tick label color
  - getTickLabelAngle
```
public float getTickLabelAngle()
```
    Get tick lable angle
    
    Returns:
    
    Tick label angle
  - setTickLabelAngle
```
public void setTickLabelAngle(float value)
```
    Set tick label angle
    
    Parameters:
    
    value - Tick label angle
  - getColumnNumber
```
public int getColumnNumber()
```
    Get column number
    
    Returns:
    
    Column number
  - setColumnNumber
```
public void setColumnNumber(int value)
```
    Set column number
    
    Parameters:
    
    value - Column number
  - isAutoRowColNum
```
public boolean isAutoRowColNum()
```
    Get if automatic set row/col number
    
    Returns:
    
    Boolean
  - setAutoRowColNum
```
public void setAutoRowColNum(boolean value)
```
    Set if automatic set row/col number
    
    Parameters:
    
    value - Boolean
  - getSymbolDimension
```
public java.awt.Dimension getSymbolDimension()
```
    Get symbol dimension
    
    Returns:
    
    Symbol dimension
  - setSymbolDimension
```
public void setSymbolDimension(java.awt.Dimension value)
```
    Set symbol dimension
    
    Parameters:
    
    value - Symbol dimension
  - setSymbolWidth
```
public void setSymbolWidth(int value)
```
    Set symbol width
    
    Parameters:
    
    value - Width
  - setSymbolHeight
```
public void setSymbolHeight(int value)
```
    Set symbol height
    
    Parameters:
    
    value - height
  - setSymbolScale
```
public void setSymbolScale(float value)
```
    Set symbol scale
    
    Parameters:
    
    value - Symble scale
  - isExtendRect
```
public boolean isExtendRect()
```
    Get if extend rectangle - or triangle
    
    Returns:
    
    Boolean
  - setExtendRect
```
public void setExtendRect(boolean value)
```
    Set if extend rectangle - or triangle
    
    Parameters:
    
    value - Boolean
  - isAutoExtendFrac
```
public boolean isAutoExtendFrac()
```
    Get if auto set extend fraction - extend has save width and height Only valid for colorbar
    
    Returns:
    
    Boolean
  - setAutoExtendFrac
```
public void setAutoExtendFrac(boolean value)
```
    Set if auto set extend fraction - extend has save width and height Only valid for colorbar
    
    Parameters:
    
    value -
  - setTickCaptions
```
public void setTickCaptions(java.util.List<java.lang.String> value)
```
    Set tick labels
    
    Parameters:
    
    value - Tick labels
  - isDrawMinLabel
```
public boolean isDrawMinLabel()
```
    Get if draw minimum value label
    
    Returns:
    
    Boolean
  - setDrawMinLabel
```
public void setDrawMinLabel(boolean value)
```
    Set if draw minimum value label
    
    Parameters:
    
    value - Boolean
  - isDrawMaxLabel
```
public boolean isDrawMaxLabel()
```
    Get if draw maximum value label
    
    Returns:
    
    Boolean
  - setDrawMaxLabel
```
public void setDrawMaxLabel(boolean value)
```
    Set if draw maximum value label
    
    Parameters:
    
    value - Boolean
  - getXShift
```
public float getXShift()
```
    Get x shift - pixel unit
    
    Returns:
    
    X shift
  - setXShift
```
public void setXShift(float value)
```
    Set x shift
    
    Parameters:
    
    value - X shift
  - getYShift
```
public float getYShift()
```
    Get y shift - pixel unit
    
    Returns:
    
    Y shift
  - setYShift
```
public void setYShift(float value)
```
    Set y shift
    
    Parameters:
    
    value - Y shift
  - draw
```
public void draw(java.awt.Graphics2D g,
                 PointF point)
```
    Draw legend
    
    Parameters:
    
    g - Graphics2D
    
    point - Start point
  - getLegendDimension
```
public java.awt.Dimension getLegendDimension(java.awt.Graphics2D g,
                                             java.awt.Dimension limitDim)
```
    Get legend dimension
    
    Parameters:
    
    g - Graphics2D
    
    limitDim - Limit dimension
    
    Returns:
    
    Legend dimension
  - getTickWidth
```
protected int getTickWidth(java.awt.Graphics2D g)
```
  - getTickHeight
```
protected int getTickHeight(java.awt.Graphics2D g)
```
  - getTickGap
```
protected int getTickGap(java.awt.Graphics2D g)
```
    Update tick gap
    
    Parameters:
    
    g - Graphics2D
    
    Returns:
    
    Ticks gap

Class ChartLegend

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

legendScheme

shrink

aspect

x

y

orientation

background

drawBackground

width

height

legendWidth

legendHeight

label

labelLocation

tickLabelFont

tickLabelColor

tickLabelAngle

drawNeatLine

neatLineColor

neatLineSize

_vBarWidth

_hBarHeight

extendRect

autoExtendFrac

drawMinLabel

drawMaxLabel

xshift

yshift

Constructor Detail

ChartLegend

Method Detail

getLegendScheme

setLegendScheme

isColorbar

setColorbar

getPosition

setPosition

getShrink

setShrink

getAspect

setAspect

getX

setX

getY

setY

getWidth

setWidth

getHeight

setHeight

getLegendWidth

setLegendWidth

getLegendHeight

setLegendHeight

getPlotOrientation

setPlotOrientation

getBackground

setBackground

isDrawBackground

setDrawBackground

isDrawNeatLine

setDrawNeatLine

getNeatLineColor

setNeatLineColor

getNeatLineSize

setNeatLineSize

getLabel

setLabel

getLabelFont

setLabelFont

getLabelColor

setLabelColor

getLabelLocation

setLabelLocation