JClass DesktopViews 6.3.0 API
Documentation

com.klg.jclass.util.legend
Interface LegendComponentLayoutUser

All Known Implementing Classes:
JCChart, JCChart3d, JCGauge

public interface LegendComponentLayoutUser

A layout manager shared by chart and gauge. That layout places the JCChartArea or JCGaugeArea class in the leftover space after the JCLegend and the header and footer JComponent's have been layed out, unless specific layout hints were set on the object in JCChart/JCGauge.


Method Summary
 JComponent getComponentArea()
          Return the JClass component's sub-component on which the actual drawing of the chart or gauge will be performed.
 int getDrawingAreaHeight()
          Get the height of the drawing area represented by this component.
 int getDrawingAreaWidth()
          Get the width of the drawing area represented by this component.
 JComponent getFooter()
          Sets the Footer property.
 JComponent getHeader()
          Gets the Header property.
 Rectangle getLayoutHints(JComponent child)
          Get layout hints for the specified component child.
 com.klg.jclass.util.legend.JCLegend getLegend()
          Gets the Legend property The Legend property controls the object that controls the display of the legend.
 Dimension getPreferredSize()
          Return the preferred size of this component.
 

Method Detail

getDrawingAreaHeight

public int getDrawingAreaHeight()
Get the height of the drawing area represented by this component.


getDrawingAreaWidth

public int getDrawingAreaWidth()
Get the width of the drawing area represented by this component.


getHeader

public JComponent getHeader()
Gets the Header property. The Header property controls the object that controls the display of the header.

Returns:
head the JComponent object associated with the header. By default it is an instance of JLabel.

getFooter

public JComponent getFooter()
Sets the Footer property. The Footer property controls the object that controls the display of the footer.

Returns:
the JComponent object associated with the footer. By default it is an instance of JLabel.

getComponentArea

public JComponent getComponentArea()
Return the JClass component's sub-component on which the actual drawing of the chart or gauge will be performed.

Returns:
the JCComponent on which to draw

getLegend

public com.klg.jclass.util.legend.JCLegend getLegend()
Gets the Legend property The Legend property controls the object that controls the display of the legend.

Returns:
the JCLegend object associated with the legend

getLayoutHints

public Rectangle getLayoutHints(JComponent child)
Get layout hints for the specified component child.

Parameters:
child - chart child -- either the componentArea, legend, header, or footer.
Returns:
Rectangle object containing the desired layout hints. Null is child is not one of the valid children of chart.

getPreferredSize

public Dimension getPreferredSize()
Return the preferred size of this component.

Returns:
the preferred size of this component

Copyright © 2004 Quest Software Inc..
All rights reserved.