|
SGT Home | |||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||||
java.lang.Object | +--gov.noaa.pmel.sgt.beans.Legend
Encapsulates reference to SGTData and key.
| Field Summary | |
static int |
COLOR
ColorKey legend type |
static int |
LINE
LineKey legend type |
static int |
NO_BORDER
No border line border style. |
static int |
PLAIN_LINE
Plain line border style. |
static int |
POINT
PointCollectionKey legend type |
static int |
RAISED
Raised line border style. |
static int |
VECTOR
VectorKey legend type |
| Constructor Summary | |
Legend()
Default constructor. |
|
Legend(java.lang.String id,
Rectangle2D.Double boundsP)
Legend constructor. |
|
| Method Summary | |
void |
addChangeListener(javax.swing.event.ChangeListener l)
Add change listener. |
int |
getBorderStyle()
Get legend border style. |
Rectangle2D.Double |
getBoundsP()
Get Legend bounds. |
int |
getColumns()
Get number of columns. |
double |
getHeightP()
Get legend height. |
java.lang.String |
getId()
Get legend identifier |
double |
getKeyLabelHeightP()
Get key label height. |
double |
getLineLength()
Get the legend line, or vector length in physical coordinages. |
Point2D.Double |
getLocationP()
Get the location of the upper left corner. |
PanelHolder |
getPanelHolder()
Get PanelHolder parent. |
java.awt.Color |
getScaleColor()
Get COLOR legend scale color. |
java.awt.Font |
getScaleLabelFont()
Get COLOR legend scale font. |
java.lang.String |
getScaleLabelFormat()
Get COLOR legend scale label format. |
double |
getScaleLabelHeightP()
Get COLOR legend scale label height in physical coordinates. |
int |
getScaleLabelInterval()
Get COLOR legend scale label interval. |
double |
getScaleLargeTicHeightP()
Get COLOR legend scale large tick height. |
int |
getScaleNumberSmallTics()
Get COLOR legend scale number of small tics. |
int |
getScaleSignificantDigits()
Get COLOR legend scale significant digits. |
double |
getScaleSmallTicHeightP()
Get COLOR legend scale small tick height. |
int |
getType()
Get legend type. |
double |
getWidthP()
Get legend width |
boolean |
isColor()
Test if legend of type COLOR. |
boolean |
isInstantiated()
Test if the key instantiated. |
boolean |
isScaleVisible()
Test if COLOR legend scale visible. |
boolean |
isVisible()
Test if legend visible. |
void |
removeAllChangeListeners()
Remove all change listeners. |
void |
removeChangeListener(javax.swing.event.ChangeListener l)
Remove change listener. |
void |
removeDesignChangeListeners()
Remove change listeners that implement DesignListener. |
void |
setBorderStyle(int borderStyle)
Set legend border style. |
void |
setBoundsP(Rectangle2D.Double boundsP)
Set legend bounds. |
void |
setColumns(int columns)
Set number of columns. |
void |
setHeightP(double heightP)
Set legend height. |
void |
setId(java.lang.String id)
Set legend identifier. |
void |
setInstantiated(boolean instantiated)
Set legend state to instatiated. |
void |
setKeyLabelHeightP(double keyLabelHeightP)
Set key label height in physical coordinates. |
void |
setLineLength(double lineLength)
Set the legend line or vector lenght in physical units. |
void |
setLocationP(Point2D.Double locationP)
Set the location of the TOP-LEFT corner |
void |
setPanelHolder(PanelHolder pHolder)
Set PanelHolder parent. |
void |
setScaleColor(java.awt.Color scaleColor)
Set COLOR legend scale color. |
void |
setScaleLabelFont(java.awt.Font scaleLabelFont)
Set COLOR legend scale font. |
void |
setScaleLabelFormat(java.lang.String scaleLabelFormat)
Set COLOR legend scale label format. |
void |
setScaleLabelHeightP(double scaleLabelHeightP)
Set COLOR legend scale label heigth. |
void |
setScaleLabelInterval(int scaleLabelInterval)
Set COLOR legend scale label interval. |
void |
setScaleLargeTicHeightP(double scaleLargeTicHeightP)
Set COLOR legend scale large tick height in physical
coordinates. |
void |
setScaleNumberSmallTics(int scaleNumberSmallTics)
Set COLOR legend scale number of small tics. |
void |
setScaleSignificantDigits(int scaleSignificantDigits)
Set COLOR legend scale significant digits. |
void |
setScaleSmallTicHeightP(double scaleSmallTicHeightP)
Set COLOR legend scale small tick height in physical
coordinates. |
void |
setScaleVisible(boolean scaleVisible)
Set COLOR legend scale visible. |
void |
setType(int type)
Set legend type. |
void |
setVisible(boolean visible)
Set visibility for legend. |
void |
setWidthP(double widthP)
Set legend width |
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
public static final int PLAIN_LINE
public static final int RAISED
public static final int NO_BORDER
public static final int LINE
public static final int COLOR
public static final int VECTOR
public static final int POINT
| Constructor Detail |
public Legend()
null.
public Legend(java.lang.String id,
Rectangle2D.Double boundsP)
id - legend identifierboundsP - bounds in physical units| Method Detail |
public void setId(java.lang.String id)
id - identifierpublic java.lang.String getId()
public void setBoundsP(Rectangle2D.Double boundsP)
boundsP - bounds in physical coordinatespublic Rectangle2D.Double getBoundsP()
public void setLocationP(Point2D.Double locationP)
locationP - upper left corner in physical coordinatespublic Point2D.Double getLocationP()
public void setHeightP(double heightP)
heightP - height on physical coordinatespublic double getHeightP()
public void setWidthP(double widthP)
widthP - width in physcial coordinatespublic double getWidthP()
public void removeChangeListener(javax.swing.event.ChangeListener l)
l - change listenerpublic void addChangeListener(javax.swing.event.ChangeListener l)
l - change listenerpublic void removeDesignChangeListeners()
DesignListener.
public void removeAllChangeListeners()
public void setVisible(boolean visible)
visible - visibility statepublic boolean isVisible()
public void setInstantiated(boolean instantiated)
instantiated - instatiation statepublic boolean isInstantiated()
public boolean isColor()
public int getType()
public void setType(int type)
COLOR, LINE,
POINT, and VECTOR.
type - legend typepublic int getBorderStyle()
public void setBorderStyle(int borderStyle)
PLAIN_LINE,
RAISED, and NO_BORDER. Default = NO_BORDER.
borderStyle - border stylepublic int getColumns()
COLOR legends.
public void setColumns(int columns)
COLOR legends. Default = 1.
columns - number of columnspublic double getLineLength()
COLOR legends.
public void setLineLength(double lineLength)
COLOR legends.
Defautl = 0.3
lineLength - line or vector lengthpublic java.awt.Color getScaleColor()
COLOR legend scale color. Only used with COLOR
legends.
public void setScaleColor(java.awt.Color scaleColor)
COLOR legend scale color. Only used with COLOR
legends. Deault = black.
scaleColor - scale colorpublic java.awt.Font getScaleLabelFont()
COLOR legend scale font. Only used with COLOR
legends.
public void setScaleLabelFont(java.awt.Font scaleLabelFont)
COLOR legend scale font. Only used with COLOR
legends. Deault = ("Helvetica", PLAIN, 10).
scaleLabelFont - scale fontpublic double getScaleLabelHeightP()
COLOR legend scale label height in physical coordinates.
Only used with COLOR legends.
public void setScaleLabelHeightP(double scaleLabelHeightP)
COLOR legend scale label heigth. Only used with COLOR
legends. Deault = 0.2.
scaleLabelHeightP - scale label heightpublic int getScaleLabelInterval()
COLOR legend scale label interval.
Only used with COLOR legends.
public void setScaleLabelInterval(int scaleLabelInterval)
COLOR legend scale label interval. Only used with COLOR
legends. Deault = 2.
scaleLabelInterval - scale label intervalpublic int getScaleNumberSmallTics()
COLOR legend scale number of small tics.
Only used with COLOR legends.
public void setScaleNumberSmallTics(int scaleNumberSmallTics)
COLOR legend scale number of small tics. Only used with COLOR
legends. Deault = 0.
scaleNumberSmallTics - scale number of small ticspublic java.lang.String getScaleLabelFormat()
COLOR legend scale label format.
Only used with COLOR legends.
public void setScaleLabelFormat(java.lang.String scaleLabelFormat)
COLOR legend scale label format. Only used with COLOR
legends. Deault = "".
scaleLabelFormat - scale label formatpublic double getScaleLargeTicHeightP()
COLOR legend scale large tick height.
Only used with COLOR legends.
public void setScaleLargeTicHeightP(double scaleLargeTicHeightP)
COLOR legend scale large tick height in physical
coordinates. Only used with COLOR
legends. Deault = 0.1.
scaleLargeTicHeightP - scale large tick heightpublic int getScaleSignificantDigits()
COLOR legend scale significant digits.
Only used with COLOR legends.
public void setScaleSignificantDigits(int scaleSignificantDigits)
COLOR legend scale significant digits. Only used with COLOR
legends. Deault = 2.
scaleSignificantDigits - scale significant digitspublic double getScaleSmallTicHeightP()
COLOR legend scale small tick height.
Only used with COLOR legends.
public void setScaleSmallTicHeightP(double scaleSmallTicHeightP)
COLOR legend scale small tick height in physical
coordinates. Only used with COLOR
legends. Deault = 0.05.
scaleSmallTicHeightP - scale small tick heightpublic boolean isScaleVisible()
COLOR legend scale visible.
Only used with COLOR legends.
public void setScaleVisible(boolean scaleVisible)
COLOR legend scale visible. Only used with COLOR
legends. Deault = true.
scaleVisible - scale visiblepublic PanelHolder getPanelHolder()
PanelHolder parent.
public void setPanelHolder(PanelHolder pHolder)
PanelHolder parent.
pHolder - panelholderpublic double getKeyLabelHeightP()
public void setKeyLabelHeightP(double keyLabelHeightP)
keyLabelHeightP - key label height
|
SGT Home | |||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||||