public class PamSymbol
extends java.lang.Object
implements java.io.Serializable, javax.swing.Icon, java.lang.Cloneable
PamSymbolDialog
,
PanelOverlayDraw
,
Serialized FormModifier and Type | Field and Description |
---|---|
static int |
ICON_HORIZONTAL_CENTRE |
static int |
ICON_HORIZONTAL_FILL |
static int |
ICON_HORIZONTAL_LEFT |
static int |
ICON_HORIZONTAL_RIGHT |
static int |
ICON_STYLE_LINE |
static int |
ICON_STYLE_SYMBOL |
static int |
ICON_VERTICAL_BOTTOM |
static int |
ICON_VERTICAL_FILL |
static int |
ICON_VERTICAL_MIDDLE |
static int |
ICON_VERTICAL_TOP |
static long |
serialVersionUID |
static int |
SYMBOL_CIRCLE |
static int |
SYMBOL_CROSS |
static int |
SYMBOL_CROSS2 |
static int |
SYMBOL_CUSTOMPOLYGON |
static int |
SYMBOL_DIAMOND |
static int |
SYMBOL_DOUBLETRIANGLEL |
static int |
SYMBOL_DOUBLETRIANGLER |
static int |
SYMBOL_HEXAGRAM |
static int |
SYMBOL_LINESEGMENT |
static int |
SYMBOL_LINESTART |
static int |
SYMBOL_NONE |
static int |
SYMBOL_PENTAGRAM |
static int |
SYMBOL_POINT |
static int |
SYMBOL_REGIONSTART |
static int |
SYMBOL_SQUARE |
static int |
SYMBOL_STAR |
static int |
SYMBOL_TRIANGLED |
static int |
SYMBOL_TRIANGLEL |
static int |
SYMBOL_TRIANGLER |
static int |
SYMBOL_TRIANGLEU |
Constructor and Description |
---|
PamSymbol()
Simplest constructor creates a PamSymbol with
default attributes.
|
PamSymbol(int symbol,
int width,
int height,
boolean fill,
java.awt.Color fillColor,
java.awt.Color lineColor)
Creates a PamSymbol with a given shape, size, colour, etc.
|
Modifier and Type | Method and Description |
---|---|
PamSymbol |
clone() |
java.awt.Rectangle |
draw(java.awt.Graphics g,
java.awt.Point pt)
Draw the symbbol at a given point using it's preset size.
|
java.awt.Rectangle |
draw(java.awt.Graphics g,
java.awt.Point pt,
double w,
double h,
boolean fill,
float lineThickness,
java.awt.Color fillColor,
java.awt.Color lineColor)
Draw the symbol using a complete new set of parameters.
|
void |
draw(java.awt.Graphics g,
java.awt.Point pt,
int width,
int height)
Draw the symbol at a given point using a new width and height.
|
static java.awt.Rectangle |
drawArrow(java.awt.Graphics g,
double x1,
double y1,
double x2,
double y2,
double headSize,
double headAngle,
boolean doubleEnded) |
static java.awt.Rectangle |
drawArrow(java.awt.Graphics g,
int x1,
int y1,
int x2,
int y2,
int headSize) |
java.awt.Polygon |
getDrawnPolygon() |
java.awt.Color |
getFillColor() |
int |
getHeight() |
int |
getIconHeight()
Returns the icon's height.
|
int |
getIconHorizontalAlignment() |
int |
getIconStyle() |
int |
getIconVerticalAlignment() |
int |
getIconWidth()
Returns the icon's width.
|
java.awt.Color |
getLineColor() |
float |
getLineThickness() |
int |
getSymbol() |
char |
getTextCode() |
static char |
getTextCode(int symbol)
Get a text code for a symbol
|
int |
getWidth() |
double[] |
getXPoints() |
double[] |
getYPoints() |
static int |
interpretTextCode(java.lang.String textCode)
Convert a single character text code into
a symbol type more or less following the Matlab symbol
definitions.
|
boolean |
isFill() |
boolean |
isSolidShape() |
PamKeyItem |
makeKeyItem(java.lang.String text)
Create a small JPanel to incorporate into
a key.
|
void |
paintIcon(java.awt.Component c,
java.awt.Graphics g,
int x,
int y) |
void |
setFill(boolean fill) |
void |
setFillColor(java.awt.Color fillColor) |
void |
setHeight(int height) |
void |
setIconHorizontalAlignment(int hAlignment) |
void |
setIconStyle(int iconStyle) |
void |
setIconVerticalAlignment(int iconVerticalAlignment) |
void |
setLineColor(java.awt.Color lineColor) |
void |
setLineThickness(float lineThickness) |
void |
setSymbol(int symbol) |
void |
setWidth(int width) |
java.lang.String |
toString() |
public static final long serialVersionUID
public static final int SYMBOL_NONE
public static final int SYMBOL_REGIONSTART
public static final int SYMBOL_LINESTART
public static final int SYMBOL_LINESEGMENT
public static final int SYMBOL_CROSS
public static final int SYMBOL_CROSS2
public static final int SYMBOL_SQUARE
public static final int SYMBOL_TRIANGLEU
public static final int SYMBOL_CIRCLE
public static final int SYMBOL_DIAMOND
public static final int SYMBOL_POINT
public static final int SYMBOL_STAR
public static final int SYMBOL_TRIANGLED
public static final int SYMBOL_TRIANGLEL
public static final int SYMBOL_TRIANGLER
public static final int SYMBOL_PENTAGRAM
public static final int SYMBOL_HEXAGRAM
public static final int SYMBOL_CUSTOMPOLYGON
public static final int SYMBOL_DOUBLETRIANGLEL
public static final int SYMBOL_DOUBLETRIANGLER
public static final int ICON_STYLE_SYMBOL
public static final int ICON_STYLE_LINE
public static final int ICON_HORIZONTAL_LEFT
public static final int ICON_HORIZONTAL_CENTRE
public static final int ICON_HORIZONTAL_RIGHT
public static final int ICON_HORIZONTAL_FILL
public static final int ICON_VERTICAL_TOP
public static final int ICON_VERTICAL_MIDDLE
public static final int ICON_VERTICAL_BOTTOM
public static final int ICON_VERTICAL_FILL
public PamSymbol()
PamSymbolDialog
public PamSymbol(int symbol, int width, int height, boolean fill, java.awt.Color fillColor, java.awt.Color lineColor)
symbol
- Symbol typewidth
- Width of symbol in pixelsheight
- Height of symbol in pixelsfill
- true if the symbol is to be filled, false if the shape should be hollowfillColor
- fill colour (required fill to be true)lineColor
- line colourpublic static int interpretTextCode(java.lang.String textCode)
textCode
- text codepublic char getTextCode()
public static char getTextCode(int symbol)
symbol
- symbol typepublic java.awt.Rectangle draw(java.awt.Graphics g, java.awt.Point pt)
g
- graphics component to draw onpt
- x,y coordinate to draw centre of symbol atpublic void draw(java.awt.Graphics g, java.awt.Point pt, int width, int height)
g
- graphics component to draw onpt
- x,y coordinate to draw centre of symbol atwidth
- width for drawing symbol (overrides preset width)height
- height for drawing symbol (overrides prest height)public java.awt.Rectangle draw(java.awt.Graphics g, java.awt.Point pt, double w, double h, boolean fill, float lineThickness, java.awt.Color fillColor, java.awt.Color lineColor)
g
- graphics component to draw onpt
- x,y coordinate to draw centre of symbol atw
- width for drawing symbol (overrides preset width)h
- height for drawing symbol (overrides prest height)fill
- true if the symbol is to be filled, false for hollowlineThickness
- outer line thicknessfillColor
- fill colourlineColor
- line colourpublic java.awt.Polygon getDrawnPolygon()
public void paintIcon(java.awt.Component c, java.awt.Graphics g, int x, int y)
paintIcon
in interface javax.swing.Icon
public java.lang.String toString()
toString
in class java.lang.Object
public boolean isSolidShape()
public int getIconWidth()
getIconWidth
in interface javax.swing.Icon
public int getIconHeight()
getIconHeight
in interface javax.swing.Icon
public boolean isFill()
public void setFill(boolean fill)
public java.awt.Color getFillColor()
public void setFillColor(java.awt.Color fillColor)
public int getHeight()
public void setHeight(int height)
public java.awt.Color getLineColor()
public void setLineColor(java.awt.Color lineColor)
public int getSymbol()
public void setSymbol(int symbol)
public int getWidth()
public void setWidth(int width)
public float getLineThickness()
public void setLineThickness(float lineThickness)
public PamKeyItem makeKeyItem(java.lang.String text)
text
- public PamSymbol clone()
clone
in class java.lang.Object
public static java.awt.Rectangle drawArrow(java.awt.Graphics g, int x1, int y1, int x2, int y2, int headSize)
public static java.awt.Rectangle drawArrow(java.awt.Graphics g, double x1, double y1, double x2, double y2, double headSize, double headAngle, boolean doubleEnded)
public double[] getXPoints()
public double[] getYPoints()
public int getIconStyle()
public void setIconStyle(int iconStyle)
iconStyle
- the iconStyle to setpublic void setIconHorizontalAlignment(int hAlignment)
hAlignment
- the icon horizontal alignmentpublic int getIconVerticalAlignment()
public void setIconVerticalAlignment(int iconVerticalAlignment)
iconVerticalAlignment
- the iconVerticalAlignment to setpublic int getIconHorizontalAlignment()