|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ast.gui.AbstractPlotControlsModel
uk.ac.starlink.ast.gui.AstTitle
public class AstTitle
AstTitle is a model of the Title element shown in say an AST Plot. It encompasses all the values that describe its representation and returns these in various formats (such as the complete AST Plot options list for drawing it).
Field Summary | |
---|---|
protected Color |
colour
The colour of the title. |
protected Font |
font
The Font used to display the title. |
protected double |
gap
The gap between title and plot border. |
static double |
GAP_MAX
The suggested maximum gap. |
static double |
GAP_MIN
The suggested minimum gap. |
static double |
GAP_STEP
The suggested gap resolution (i.e. |
protected DefaultGrfFontManager |
grfFontManager
Reference to the GrfFontManager object. |
protected boolean |
isSet
Whether title is set or unset. |
static String |
NULL_TITLE
A title to show that is the same as null. |
protected boolean |
show
Whether the title should be shown (different from unset). |
protected String |
title
The value for the title. |
Fields inherited from class uk.ac.starlink.ast.gui.AbstractPlotControlsModel |
---|
listeners |
Constructor Summary | |
---|---|
AstTitle()
Create a empty instance. |
|
AstTitle(String title)
Create an instance with initial value. |
Method Summary | |
---|---|
void |
encode(Element rootElement)
Description of the Method |
String |
getAstOptions()
Get the AST plot options description of this object. |
Color |
getColour()
Get the colour of the title. |
Font |
getFont()
Get the Font used to draw title. |
double |
getGap()
Get the gap between title and border. |
boolean |
getShown()
Get whether the title is to be shown. |
boolean |
getState()
Return if the title is set or unset. |
String |
getTagName()
The name of our enclosing tag. |
String |
getTitle()
Get the current title. |
void |
setColour(Color colour)
Set the colour of the title. |
void |
setDefaults()
Set/reset all values to their defaults. |
void |
setFont(Font font)
Set the Font to be used when displaying title. |
void |
setFromString(String name,
String value)
Set the value of a member variable by matching its name to a known local property string. |
void |
setGap(double gap)
Set the gap between title and border. |
void |
setShown(boolean show)
Set whether the title should be shown or not. |
void |
setState(boolean isSet)
Set whether the title is set or unset (unset implies that all title properties should remain at their AST defaults). |
void |
setTitle(String title)
Set the title string. |
String |
toString()
Get a string representation of the AST options. |
Methods inherited from class uk.ac.starlink.ast.gui.AbstractPlotControlsModel |
---|
addChangeListener, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, booleanFromString, booleanToString, colorFromString, colorToString, decode, doubleFromString, doubleToString, fireChanged, fontFromString, fontToString, getChildren, getElementName, getElementValue, intFromString, intToString, longFromString, longToString, removeChangeListener |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected boolean isSet
protected boolean show
protected String title
protected Font font
protected Color colour
protected double gap
public static final double GAP_MIN
public static final double GAP_MAX
public static final double GAP_STEP
public static final String NULL_TITLE
protected DefaultGrfFontManager grfFontManager
Constructor Detail |
---|
public AstTitle()
public AstTitle(String title)
title
- Description of the ParameterMethod Detail |
---|
public void setDefaults()
public void setState(boolean isSet)
isSet
- The new state valuepublic boolean getState()
public void setShown(boolean show)
show
- The new shown valuepublic boolean getShown()
public void setTitle(String title)
title
- The new title valuepublic String getTitle()
public void setFont(Font font)
font
- The new font valuepublic Font getFont()
public void setColour(Color colour)
colour
- The new colour valuepublic Color getColour()
public void setGap(double gap)
gap
- The new gap valuepublic double getGap()
public String getAstOptions()
public String toString()
toString
in class Object
public String getTagName()
public void encode(Element rootElement)
encode
in interface XMLEncodeDecode
encode
in class AbstractPlotControlsModel
rootElement
- Description of the Parameterpublic void setFromString(String name, String value)
setFromString
in class AbstractPlotControlsModel
name
- The new fromString valuevalue
- The new fromString value
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |