edu.swri.swiftvis.plot.styles
Class RectangleGridSurface.RGLegend
java.lang.Object
edu.swri.swiftvis.plot.styles.RectangleGridSurface.RGLegend
- All Implemented Interfaces:
- PlotLegend, java.io.Serializable
- Enclosing class:
- RectangleGridSurface
private class RectangleGridSurface.RGLegend
- extends java.lang.Object
- implements PlotLegend, java.io.Serializable
Method Summary |
void |
drawToGraphics(java.awt.Graphics2D g,
java.awt.geom.Rectangle2D bounds)
This method will attempt to draw the legend information to the provided graphics
object inside the provided bounds. |
javax.swing.JComponent |
getPropertiesPanel()
As the name implies, this method returns a panel that can be used to edit the
properties of a legend object. |
boolean |
isDrawn()
This method tells you whether this legend element is to be drawn based on user
settings. |
double |
relativeVerticalSize()
This method returns a double for the relative amount of space that this
legend component should take. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
drawn
private EditableBoolean drawn
vertSize
private EditableDouble vertSize
propPanel
private transient javax.swing.JPanel propPanel
font
private transient java.awt.Font font
frc
private transient java.awt.font.FontRenderContext frc
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
RectangleGridSurface.RGLegend
private RectangleGridSurface.RGLegend()
getPropertiesPanel
public javax.swing.JComponent getPropertiesPanel()
- Description copied from interface:
PlotLegend
- As the name implies, this method returns a panel that can be used to edit the
properties of a legend object.
- Specified by:
getPropertiesPanel
in interface PlotLegend
- Returns:
- A Swing component setup to allow modification of this object.
drawToGraphics
public void drawToGraphics(java.awt.Graphics2D g,
java.awt.geom.Rectangle2D bounds)
- Description copied from interface:
PlotLegend
- This method will attempt to draw the legend information to the provided graphics
object inside the provided bounds.
- Specified by:
drawToGraphics
in interface PlotLegend
- Parameters:
g
- The Graphics2D object that is being drawn to.bounds
- A rectangle in which the drawing should be confined. Things drawn outside may be clipped.
isDrawn
public boolean isDrawn()
- Description copied from interface:
PlotLegend
- This method tells you whether this legend element is to be drawn based on user
settings.
- Specified by:
isDrawn
in interface PlotLegend
- Returns:
- A boolean for whether it should be drawn.
relativeVerticalSize
public double relativeVerticalSize()
- Description copied from interface:
PlotLegend
- This method returns a double for the relative amount of space that this
legend component should take. This can be a constant determined by the author or
something settable in the GUI.
- Specified by:
relativeVerticalSize
in interface PlotLegend
- Returns:
- A proportional amount of space this legend element should take up.