org.opensourcephysics.display.axes
Class PolarType1

java.lang.Object
  org.opensourcephysics.display.axes.AbstractAxes
      org.opensourcephysics.display.axes.AbstractPolarAxis
          org.opensourcephysics.display.axes.PolarType1

All Implemented Interfaces:

DrawableAxes, PolarAxes, Dimensioned, Drawable

public class PolarType1
extends AbstractPolarAxis
implements PolarAxes, Dimensioned

Field Summary

Fields inherited from class org.opensourcephysics.display.axes.AbstractPolarAxis

autospaceRings, dr, dtheta

Fields inherited from class org.opensourcephysics.display.axes.AbstractAxes

defaultBottomGutter, defaultLeftGutter, defaultRightGutter, defaultTopGutter, drawingPanel, gridcolor, interiorColor, labelFont, labelFormat, superscriptFont, titleFont, titleLine, visible

Constructor Summary

PolarType1(PlottingPanel panel)
Constructs polar coordinate axes for the given panel.

PolarType1(PlottingPanel panel, java.lang.String rLabel, java.lang.String phiLabel, double phiOffset)
Constructs polar coordinate axes for the given panel.

Method Summary

void	draw(DrawingPanel panel, java.awt.Graphics g) Draws a representation of an object in a drawing panel.
java.awt.Dimension	getInterior(DrawingPanel panel) Gets the interior dimension of the drawing panel in pixel units.
java.lang.String	getXLabel() Gets the x axis label.
java.lang.String	getYLabel() Gets the y axis label.
void	setShowMajorXGrid(boolean showGrid) Shows a grid line for every x axis major tickmark.
void	setShowMajorYGrid(boolean showGrid) Shows a grid line for every y axis major tickmark.
void	setShowMinorXGrid(boolean showGrid) Shows a grid line for every x axis minor tickmark.
void	setShowMinorYGrid(boolean showGrid) Shows a grid line for every y axis minor tickmark.
void	setXLabel(java.lang.String s, java.lang.String font_name) Sets the x label of the axes.
void	setXLog(boolean isLog) Sets the x axis to linear or logarithmic.
void	setYLabel(java.lang.String s, java.lang.String font_name) Sets the y label of the axes.
void	setYLog(boolean isLog) Sets the y axis to linear or logarithmic.

Methods inherited from class org.opensourcephysics.display.axes.AbstractPolarAxis

autospaceRings, drawRAxis, drawRings, drawSpokes, getDeltaR, getDeltaTheta, setDeltaR, setDeltaTheta, setLabelFormat

Methods inherited from class org.opensourcephysics.display.axes.AbstractAxes

getInteriorBackground, getTitle, isVisible, resetPanelGutters, resizeFonts, setDefaultGutters, setInteriorBackground, setTitle, setVisible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensourcephysics.display.axes.PolarAxes

autospaceRings, drawRings, drawSpokes, getDeltaR, getDeltaTheta, setDeltaR, setDeltaTheta, setInteriorBackground

Methods inherited from interface org.opensourcephysics.display.axes.DrawableAxes

getInteriorBackground, getTitle, resizeFonts, setTitle, setVisible

Constructor Detail

PolarType1

public PolarType1(PlottingPanel panel,
                  java.lang.String rLabel,
                  java.lang.String phiLabel,
                  double phiOffset)

Constructs polar coordinate axes for the given panel.

Parameters:

panel - PlottingPanel

rLabel -

phiLabel -

phiOffset - double offset the phi coordinate

PolarType1

public PolarType1(PlottingPanel panel)

Constructs polar coordinate axes for the given panel.

Parameters:

panel - PlottingPanel

Method Detail

getInterior

public java.awt.Dimension getInterior(DrawingPanel panel)

Gets the interior dimension of the drawing panel in pixel units. Because this method is called before the pixel scale is set, it may change the gutters and the preferred scale.

Specified by:

getInterior in interface Dimensioned

Parameters:

panel - the drawing panel that requested the interior

Returns:

the interior dimension

setXLabel

public void setXLabel(java.lang.String s,
                      java.lang.String font_name)

Sets the x label of the axes. The font names understood are those understood by java.awt.Font.decode(). If the font name is null, the font remains unchanged.

Specified by:

setXLabel in interface DrawableAxes

Parameters:

s - the label

font_name - an optional font name

setYLabel

public void setYLabel(java.lang.String s,
                      java.lang.String font_name)

Sets the y label of the axes. The font names understood are those understood by java.awt.Font.decode(). If the font name is null, the font remains unchanged.

Specified by:

setYLabel in interface DrawableAxes

Parameters:

s - the label

font_name - an optional font name

getXLabel

public java.lang.String getXLabel()

Gets the x axis label.

Specified by:

getXLabel in interface DrawableAxes

Returns:

String

getYLabel

public java.lang.String getYLabel()

Gets the y axis label.

Specified by:

getYLabel in interface DrawableAxes

Returns:

String

setXLog

public void setXLog(boolean isLog)

Sets the x axis to linear or logarithmic.

Parameters:

isLog - true for log scale; false otherwise

setYLog

public void setYLog(boolean isLog)

Sets the y axis to linear or logarithmic.

Parameters:

isLog - true for log scale; false otherwise

setShowMajorXGrid

public void setShowMajorXGrid(boolean showGrid)

Shows a grid line for every x axis major tickmark.

Specified by:

setShowMajorXGrid in interface DrawableAxes

setShowMinorXGrid

public void setShowMinorXGrid(boolean showGrid)

Shows a grid line for every x axis minor tickmark.

Specified by:

setShowMinorXGrid in interface DrawableAxes

setShowMajorYGrid

public void setShowMajorYGrid(boolean showGrid)

Shows a grid line for every y axis major tickmark.

Specified by:

setShowMajorYGrid in interface DrawableAxes

setShowMinorYGrid

public void setShowMinorYGrid(boolean showGrid)

Shows a grid line for every y axis minor tickmark.

Specified by:

setShowMinorYGrid in interface DrawableAxes

draw

public void draw(DrawingPanel panel,
                 java.awt.Graphics g)

Draws a representation of an object in a drawing panel.

Specified by:

draw in interface Drawable

Parameters:

panel -

g -