org.opensourcephysics.display.axes

Class CustomAxes

java.lang.Object

org.opensourcephysics.display.axes.AbstractAxes

org.opensourcephysics.display.axes.CustomAxes

All Implemented Interfaces:

DrawableAxes, Drawable

public class CustomAxes
extends AbstractAxes
implements DrawableAxes

CustomAxes defines a simple axes with an interior and a title. This object can be customized by adding drawable components.

Author:

W. Christian

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
CustomAxes(PlottingPanel panel) Constructor CustomAxes

Method Summary

Methods

Modifier and Type	Method and Description
void	addDrawable(Drawable drawable) Adds a drawable object to the drawable list.
void	draw(DrawingPanel panel, java.awt.Graphics g) Draws the axes in a drawing panel.
java.lang.String	getTitle() Gets the title.
java.lang.String	getXLabel() Gets the x axis label.
java.lang.String	getYLabel() Gets the y axis label.
void	setInteriorBackground(java.awt.Color color) Sets the interior background color.
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	setTitle(java.lang.String s, java.lang.String font_name) Set a title that will be drawn within the drawing panel.
void	setVisible(boolean isVisible) Sets the visibility of the axes.
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.AbstractAxes

getInteriorBackground, isVisible, resetPanelGutters, resizeFonts, setDefaultGutters

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.DrawableAxes

resizeFonts

Constructor Detail

CustomAxes

public CustomAxes(PlottingPanel panel)

Constructor CustomAxes

Parameters:

panel -

Method Detail

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

getTitle

public java.lang.String getTitle()

Gets the title.

Specified by:

getTitle in interface DrawableAxes

Overrides:

getTitle in class AbstractAxes

Returns:

String

setTitle

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

Set a title that will be drawn within the drawing panel. The font names understood are those understood by java.awt.Font.decode(). If the font name is null, the font remains unchanged.

Specified by:

setTitle in interface DrawableAxes

Overrides:

setTitle in class AbstractAxes

Parameters:

s - the label

font_name - an optional font name

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

setVisible

public void setVisible(boolean isVisible)

Sets the visibility of the axes.

Specified by:

setVisible in interface DrawableAxes

Overrides:

setVisible in class AbstractAxes

Parameters:

isVisible - true if the axes are visible

setInteriorBackground

public void setInteriorBackground(java.awt.Color color)

Sets the interior background color.

Specified by:

setInteriorBackground in interface DrawableAxes

Overrides:

setInteriorBackground in class AbstractAxes

Parameters:

color -

setShowMajorXGrid

public void setShowMajorXGrid(boolean showGrid)

Shows a grid line for every x axis major tickmark.

Specified by:

setShowMajorXGrid in interface DrawableAxes

Parameters:

showGrid -

setShowMinorXGrid

public void setShowMinorXGrid(boolean showGrid)

Shows a grid line for every x axis minor tickmark.

Specified by:

setShowMinorXGrid in interface DrawableAxes

Parameters:

showGrid -

setShowMajorYGrid

public void setShowMajorYGrid(boolean showGrid)

Shows a grid line for every y axis major tickmark.

Specified by:

setShowMajorYGrid in interface DrawableAxes

Parameters:

showGrid -

setShowMinorYGrid

public void setShowMinorYGrid(boolean showGrid)

Shows a grid line for every y axis minor tickmark.

Specified by:

setShowMinorYGrid in interface DrawableAxes

Parameters:

showGrid -

addDrawable

public void addDrawable(Drawable drawable)

Adds a drawable object to the drawable list.

Parameters:

drawable -

draw

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

Draws the axes in a drawing panel.

Specified by:

draw in interface Drawable

Parameters:

panel -

g -