oracle.ord.media.chart.legend
Class Legend

java.lang.Object
  |
  +--java.awt.Component
        |
        +--oracle.ord.media.chart.Chart
              |
              +--oracle.ord.media.chart.legend.Legend

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

Direct Known Subclasses:

AxisChart, PieChart

public class Legend

extends Chart

Legends display rows of labels and their associated color. Legends are used by axis charts to identify multiple series names by color. Legends are used by pie charts to display pie slice labels that cannot be placed inside the pie slice.

Legends are automatically instantiated and placed by the chart package. Additional controls are provided to allow the user to control the placement and style of legends:

• setLegendInside()
  For axis charts, places the legend inside the plot window.
• setLegendAlignment()
  Although legends are automatically placed and generated by the chart package, users can override the placement of legends with setLegendAlignment(). For example, to force the legend alignment to the right (EAST), invoke the following:

  setLegendAlignment(Legend.EAST);
  

  Note that axis charts and pie charts support different choices of legend placements. See setLegendAlignment() for more information on which alignments are compatible with each type of chart.

• setLegendForeground() and setLegendBackground()
  Set the foreground and background colors of the legend. The foreground corresponds to the font color.
  
• setLegendEdgeColor()
  Sets the color of the thin perimeter rectangle.
• setLegendDisable()
  Disable the generation of a legend.
  
• setLegendDisplaySingleSeries()
  By default, legends are displayed for two or more items. Invoking setLegendDisplaySingleSeries() forces even single item legends to be displayed.
  

  See Also:

  Serialized Form

  Inner Class Summary

  class

  Legend.LegendElement

  Inner classes inherited from class oracle.ord.media.chart.Chart

  Chart.ChartLabel

  Field Summary

  static int	DERIVED System-defined legend orientation.
  static int	EAST Orient the legend in the EAST.
  static int	NORTH Orient the legend in the NORTH.
  static int	NORTHEAST Orient the legend in the NORTHEAST.
  static int	NORTHWEST Orient the legend in the NORTHWEST.
  static int	SOUTH Orient the legend in the SOUTH.
  static int	SOUTHEAST Orient the legend in the SOUTHEAST.
  static int	SOUTHWEST Orient the legend in the SOUTHWEST.
  static int	USERDEFINED Orient the legend using user-defined coordinates.
  static int	WEST Orient the legend in the WEST.

  Fields inherited from class java.awt.Component

  BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

  Fields inherited from interface java.awt.image.ImageObserver

  ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

  Constructor Summary

  Legend()
  

  Method Summary

  int	getLegendAlignment() Return the legend's alignment constant.
  java.awt.Color	getLegendBackground() Get the background color of the legend.
  boolean	getLegendDisable() Return the boolean associated with drawing the legend.
  boolean	getLegendDisplaySingleSeries() Return the boolean associated with whether to display legends for even one series.
  java.awt.Color	getLegendEdgeColor() Get the edge color of the legend.
  boolean	getLegendEdgeDisable() Get the disable flag
  java.awt.Color	getLegendForeground() Get the foreground color of the legend.
  boolean	getLegendInside() Get the legend placement.
  void	setLegendAlignment(int alignment) Set the legend alignment.
  void	setLegendBackground(java.awt.Color c) Set the background color of the legend.
  void	setLegendDisable() Disable the generation of the legend.
  void	setLegendDisplaySingleSeries() Enable the generation of the legend for even one series.
  void	setLegendEdgeColor(java.awt.Color c) Set the edge color of the legend.
  void	setLegendEdgeDisable() Disable drawing the legend edge
  void	setLegendFont(java.awt.Font f) Set the font of the legend.
  void	setLegendForeground(java.awt.Color c) Set the foreground color of the legend.
  void	setLegendInside() Place the legend inside the the chart's plot window.
  void	setLegendOffsetX(int offsetX) Adjust the x location of the legend by the supplied offset.
  void	setLegendOffsetY(int offsetY) Adjust the y location of the legend by the supplied offset.

  Methods inherited from class oracle.ord.media.chart.Chart

  getBackground, getBorderBottom, getBorderLeft, getBorderRight, getBorderTop, getEdgeColor, getFootnote, getHeight, getMinimumSize, getPreferredSize, getRenderingHintsChart, getSize, getSubtitle, getTitle, getVersion, getWidth, isSetRenderingHintsChart, setBackground, setBorderBottom, setBorderLeft, setBorderRight, setBorderTop, setEdgeColor, setRenderingHintsChart, setTitlesForeground

  Methods inherited from class java.awt.Component

  action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, deliverEvent, disable, dispatchEvent, doLayout, enable, enable, enableInputMethods, getAccessibleContext, getAlignmentX, getAlignmentY, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFont, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, size, toString, transferFocus, update, validate

  Methods inherited from class java.lang.Object

  equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

  Field Detail

  DERIVED

  public static final int DERIVED

  System-defined legend orientation. The default for pie charts.

  NORTHWEST

  public static final int NORTHWEST

  Orient the legend in the NORTHWEST.

  NORTHEAST

  public static final int NORTHEAST

  Orient the legend in the NORTHEAST.

  NORTH

  public static final int NORTH

  Orient the legend in the NORTH.

  SOUTHWEST

  public static final int SOUTHWEST

  Orient the legend in the SOUTHWEST.

  SOUTHEAST

  public static final int SOUTHEAST

  Orient the legend in the SOUTHEAST.

  SOUTH

  public static final int SOUTH

  Orient the legend in the SOUTH.

  EAST

  public static final int EAST

  Orient the legend in the EAST.

  WEST

  public static final int WEST

  Orient the legend in the WEST.

  USERDEFINED

  public static final int USERDEFINED

  Orient the legend using user-defined coordinates.

  Constructor Detail

  Legend

  public Legend()

  Method Detail

  setLegendFont

  public void setLegendFont(java.awt.Font f)

  Set the font of the legend.

  Parameters:

  f - The font.

  getLegendDisable

  public boolean getLegendDisable()

  Return the boolean associated with drawing the legend. True is returned if the legend has been disabled, otherwise false is returned.

  setLegendDisable

  public void setLegendDisable()

  Disable the generation of the legend.

  setLegendInside

  public void setLegendInside()

  Place the legend inside the the chart's plot window.

  getLegendInside

  public boolean getLegendInside()

  Get the legend placement.

  setLegendDisplaySingleSeries

  public void setLegendDisplaySingleSeries()

  Enable the generation of the legend for even one series.

  getLegendDisplaySingleSeries

  public boolean getLegendDisplaySingleSeries()

  Return the boolean associated with whether to display legends for even one series.

  getLegendAlignment

  public int getLegendAlignment()

  Return the legend's alignment constant.

  setLegendAlignment

  public void setLegendAlignment(int alignment)
                          throws ChartException

  Set the legend alignment. Possible alignment values are:

  • PieChart: Legend.DERIVED, Legend.NORTH, Legend.SOUTH, Legend.EAST, and Legend.WEST
  • AxisChart, outside plot window: Legend.SOUTH, and Legend.EAST
  • AxisChart, inside plot window: Legend.NORTH, Legend.SOUTH, Legend.EAST, Legend.WEST, Legend.NORTHEAST, Legend.NORTHWEST, Legend.SOUTHEAST, and Legend.SOUTHWEST

  Note that using Legend.DERIVED for pie charts will result in either a SOUTH or EAST legend placement. This is the default alignment for pie charts. The default alignment for axis charts is outside the plot window, using Legend.SOUTH placement.

  Parameters:

  alignment - The alignment to be set.

  Throws:

  java.lang.IllegalArgumentException - if an improper value for alignment is given.

  setLegendOffsetX

  public void setLegendOffsetX(int offsetX)

  Adjust the x location of the legend by the supplied offset. Note that legend locations are derived from the alignment constant. setLegendOffsetX() incrementally adjusts the derived x location.

  setLegendOffsetY

  public void setLegendOffsetY(int offsetY)

  Adjust the y location of the legend by the supplied offset. Note that legend locations are derived from the alignment constant. setLegendOffsetY() incrementally adjusts the derived y location.

  getLegendBackground

  public java.awt.Color getLegendBackground()

  Get the background color of the legend.

  setLegendBackground

  public void setLegendBackground(java.awt.Color c)

  Set the background color of the legend.

  getLegendForeground

  public java.awt.Color getLegendForeground()

  Get the foreground color of the legend.

  setLegendForeground

  public void setLegendForeground(java.awt.Color c)

  Set the foreground color of the legend.

  getLegendEdgeColor

  public java.awt.Color getLegendEdgeColor()

  Get the edge color of the legend.

  setLegendEdgeColor

  public void setLegendEdgeColor(java.awt.Color c)

  Set the edge color of the legend.

  setLegendEdgeDisable

  public void setLegendEdgeDisable()

  Disable drawing the legend edge

  getLegendEdgeDisable

  public boolean getLegendEdgeDisable()

  Get the disable flag