Property Detail

• java.awt.Color backgroundColor

• java.util.List<LegendEntry> entries

• int gapBetweenEntries

• int legendEntryHeight

• int legendEntryWidth

• java.lang.String numberFormat

• java.awt.Color textColor

• java.awt.Font textFont

• java.lang.String title

• java.awt.Color titleColor

• java.awt.Font titleFont

Constructor Detail

• LegendItem(int x, int y, int width, int height)

  Create a Legend from the top left with the given width and height.

  Parameters:

  x - The number of pixels from the left

  y - The number of pixels from the top

  width - The width in pixels

  height - The height in pixels

Method Detail

• LegendItem addColorMapEntry(java.lang.String title, ColorMap colorMap)

  Add a ColorMap legend entry

  Parameters:

  title - The title

  symbolizer - The Raster's Symbolizer

  Returns:

  The LegendItem

• LegendItem addGroupEntry(java.lang.String title)

  Add a Group Entry

  Parameters:

  title - The title

  Returns:

  The LegendItem

• LegendItem addImageEntry(java.lang.String title, java.awt.Image image)

  Add an Image Entry

  Parameters:

  title - The title

  Returns:

  The LegendItem

• LegendItem addLayer(Layer layer)

  Add Legend entries for a Layer

  Parameters:

  layer - A Layer

  Returns:

  The LegendItem

• LegendItem addLineEntry(java.lang.String title, Style symbolizer)

  Add a Line legend entry

  Parameters:

  title - The title

  symbolizer - The Line's Symbolizer

  Returns:

  The LegendItem

• LegendItem addMap(Map map)

  Add Legend entries for a Map

  Parameters:

  map - The Map

  Returns:

  The LegendItem

• LegendItem addPointEntry(java.lang.String title, Style symbolizer)

  Add a Point legend entry

  Parameters:

  title - The title

  symbolizer - The Point's Symbolizer

  Returns:

  The LegendItem

• LegendItem addPolygonEntry(java.lang.String title, Style symbolizer)

  Add a Polygon legend entry

  Parameters:

  title - The title

  symbolizer - The Polygon's Symbolizer

  Returns:

  The LegendItem

• LegendItem addRaster(Raster raster)

  Add Legend entries for a Raster

  Parameters:

  raster - The Raster

  Returns:

  The LegendItem

• LegendItem backgroundColor(java.awt.Color backgroundColor)

  Set the background color

  Parameters:

  backgroundColor - The background color

  Returns:

  The LegendItem

• LegendItem gapBetweenEntries(int gapBetweenEntries)

  Set the gap between entries

  Parameters:

  gapBetweenEntries - The gap between entries

  Returns:

  The LegendItem

• LegendItem legendEntryHeight(int legendEntryHeight)

  Set the legen entry height

  Parameters:

  legendEntryHeight - The legend entry height

  Returns:

  The LegendItem

• LegendItem legendEntryWidth(int legendEntryWidth)

  Set the legend entry width

  Parameters:

  legendEntryWidth - The legend entry width

  Returns:

  The LegendItem

• LegendItem numberFormat(java.lang.String numberFormat)

  Set the number format

  Parameters:

  numberFormat - The number format

  Returns:

  The LegendItem

• LegendItem textColor(java.awt.Color textColor)

  Set the text Color

  Parameters:

  textColor - The text Color

  Returns:

  The LegendItem

• LegendItem textFont(java.awt.Font textFont)

  Set the text Font

  Parameters:

  textFont - The text Font

  Returns:

  The LegendItem

• LegendItem title(java.lang.String title)

  Set the legend title

  Parameters:

  title - The title

  Returns:

  The LegendItem

• LegendItem titleColor(java.awt.Color titleColor)

  Set the title Color

  Parameters:

  titleColor - The title Color

  Returns:

  The LegendItem

• LegendItem titleFont(java.awt.Font titleFont)

  Set the title Font

  Parameters:

  titleFont - The title Font

  Returns:

  The LegendItem

• @java.lang.Override java.lang.String toString()