Package PamView

Class PamSymbolBase

java.lang.Object

PamView.PamSymbolBase

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

PamSymbol, PamSymbolFX

public abstract class PamSymbolBase
extends Object
implements Serializable, Cloneable

Base class for both FX and Swing PamSymbols

Author:

dg50

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final long	serialVersionUID

Constructor Summary

Constructors

Constructor	Description
PamSymbolBase(SymbolData symbolData)	Construct a symbol with shape information.

Method Summary

Modifier and Type	Method	Description
PamSymbolBase	clone()
double	getDHeight()	Get the symbol height as an double
double	getDWidth()	Get the symbol width as a double
float	getLineThickness()	Get the symbol line thickness
SymbolData	getSymbolData()	Get the symbol data - all the information needed to describe the symbol, shape, colour, etc.
char	getTextCode()
static char	getTextCode(PamSymbolType symbol)	Get a text code for a symbol
static PamSymbolType	interpretTextCode(String textCode)	Convert a single character text code into a symbol type more or less following the Matlab symbol definitions.
boolean	isFill()	Is the symbol filled
void	setFill(boolean fill)	Set the symbol fill
void	setHeight(double height)	Set the symbol height
void	setLineThickness(float lineThickness)	Set the symbol line thickness
void	setSymbolData(SymbolData symbolData)	Set the symbol data.
void	setWidth(double width)	Set the symbol width

Methods inherited from class java.lang.Object

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

Field Details

serialVersionUID

public static final long serialVersionUID

See Also:

• Constant Field Values

Constructor Details

PamSymbolBase

public PamSymbolBase(SymbolData symbolData)

Construct a symbol with shape information.

Parameters:

symbolData -

Method Details

interpretTextCode

public static PamSymbolType interpretTextCode(String textCode)

Convert a single character text code into a symbol type more or less following the Matlab symbol definitions.

Parameters:

textCode - text code

Returns:

symbol type

getTextCode

public char getTextCode()

Returns:

the text code for this symbol

getSymbolData

public SymbolData getSymbolData()

Get the symbol data - all the information needed to describe the symbol, shape, colour, etc.

Returns:

setSymbolData

public void setSymbolData(SymbolData symbolData)

Set the symbol data.

Parameters:

symbolData -

getTextCode

public static char getTextCode(PamSymbolType symbol)

Get a text code for a symbol

Parameters:

symbol - symbol type

Returns:

text code

setWidth

public void setWidth(double width)

Set the symbol width

Parameters:

d - symbol width in pixels.

setHeight

public void setHeight(double height)

Set the symbol height

Parameters:

height - symbol height in pixels

getDWidth

public double getDWidth()

Get the symbol width as a double

Returns:

symbol width in pixels

See Also:

• invalid @see

  Symbol width as an int

getDHeight

public double getDHeight()

Get the symbol height as an double

Returns:

symbol height in pixels

See Also:

• invalid @see

  Symbol height as an int

isFill

public boolean isFill()

Is the symbol filled

Returns:

true if filled

setFill

public void setFill(boolean fill)

Set the symbol fill

Parameters:

fill -

getLineThickness

public float getLineThickness()

Get the symbol line thickness

Returns:

line thickness

setLineThickness

public void setLineThickness(float lineThickness)

Set the symbol line thickness

Parameters:

lineThickness - line thickness

clone

public PamSymbolBase clone()
                    throws CloneNotSupportedException

Throws:

CloneNotSupportedException