org.jplot2d.element.impl

Class TitleImpl

java.lang.Object

org.jplot2d.element.impl.ElementImpl

org.jplot2d.element.impl.ComponentImpl

org.jplot2d.element.impl.TitleImpl

All Implemented Interfaces:

Element, ComponentEx, ElementEx, TitleEx, MovableComponent, PComponent, TextComponent, Title

public class TitleImpl
extends ComponentImpl
implements TitleEx

Constructor Summary

Constructors

Constructor and Description
TitleImpl()

Method Summary

Modifier and Type	Method and Description
void	calcSize() Called by plot to calculate size of this title.
boolean	canContribute() Returns true if this component can contribute visible parts to plot rendering artifact when this component is visible.
void	copyFrom(ElementEx src) Copies all properties from given src to this element.
void	draw(java.awt.Graphics2D g) Draw this component only.
java.awt.geom.Rectangle2D	getBounds() Returns the paper bounds relative to its location.
double	getGapFactor() Returns the ratio of gap to its height.
HAlign	getHAlign() Get the horizontal alignment.
java.lang.String	getId() Returns the id string of this element
InvokeStep	getInvokeStepFormParent() Return the invoke step to get this object from its parent.
java.awt.geom.Point2D	getLocation() Gets the location of this title.
PlotEx	getParent() Gets the parent of this component.
TitlePosition	getPosition() Gets the current position of this title in a layer.
java.awt.geom.Dimension2D	getSize() Returns the paper size of this component.
java.lang.String	getText() Returns the text string.
MathElement	getTextModel()
VAlign	getVAlign() Get the vertical alignment.
void	setGapFactor(double factor) Sets the ratio of gap to its height.
void	setHAlign(HAlign hAlign) Set the horizontal alignment.
void	setLocation(double locX, double locY) Moves this component to a new location.
void	setLocation(java.awt.geom.Point2D p) Moves this title to a new location.
void	setPosition(TitlePosition position) Sets the position of this title.
void	setText(java.lang.String text) Defines the single line of text to be displayed.
void	setTextModel(MathElement model)
void	setVAlign(VAlign vAlign) Set the vertical alignment.
void	setVisible(boolean visible) Shows or hides this component depending on the value of parameter b.
void	thisEffectiveColorChanged() Called when setColor() or parentEffectiveColorChanged() change the effective color of this component.
void	thisEffectiveFontChanged() Called when setFontXxx() or parentEffectiveFontChanged() change the effective font of this component.

Methods inherited from class org.jplot2d.element.impl.ComponentImpl

addPropertyChangeListener, copyStructure, getColor, getEffectiveColor, getEffectiveFont, getEffectiveFontName, getEffectiveFontSize, getEffectiveFontStyle, getFontName, getFontScale, getFontSize, getFontStyle, getMooringMap, getPaperTransform, getSelectableBounds, getZOrder, isCacheable, isMovable, isRedrawNeeded, isSelectable, isVisible, parentEffectiveColorChanged, parentEffectiveFontChanged, removePropertyChangeListener, setCacheable, setColor, setFont, setFontName, setFontScale, setFontSize, setFontStyle, setMovable, setRedrawNeeded, setSelectable, setZOrder

Methods inherited from class org.jplot2d.element.impl.ElementImpl

getEnvironment, getFullId, notify, setParent, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jplot2d.element.Title

isMovable, setMovable

Methods inherited from interface org.jplot2d.element.PComponent

getColor, getEffectiveFont, getFontName, getFontScale, getFontSize, getFontStyle, getPaperTransform, getSelectableBounds, getZOrder, isCacheable, isSelectable, isVisible, setCacheable, setColor, setFont, setFontName, setFontScale, setFontSize, setFontStyle, setSelectable, setZOrder

Methods inherited from interface org.jplot2d.element.Element

getEnvironment

Methods inherited from interface org.jplot2d.element.impl.ComponentEx

copyStructure, getEffectiveColor, getEffectiveFontName, getEffectiveFontSize, getEffectiveFontStyle, getMooringMap, isMovable, isRedrawNeeded, parentEffectiveColorChanged, parentEffectiveFontChanged, setMovable, setRedrawNeeded

Methods inherited from interface org.jplot2d.element.impl.ElementEx

getFullId, notify, setParent

Constructor Detail

TitleImpl

public TitleImpl()

Method Detail

getId

public java.lang.String getId()

Description copied from interface: Element

Returns the id string of this element

Specified by:

getId in interface Element

Returns:

the id string

getInvokeStepFormParent

public InvokeStep getInvokeStepFormParent()

Description copied from interface: ElementEx

Return the invoke step to get this object from its parent.

Specified by:

getInvokeStepFormParent in interface ElementEx

Returns:

the invoke step

getParent

public PlotEx getParent()

Description copied from interface: Element

Gets the parent of this component.

Specified by:

getParent in interface Element

Specified by:

getParent in interface ComponentEx

Specified by:

getParent in interface ElementEx

Specified by:

getParent in interface TitleEx

Specified by:

getParent in interface PComponent

Overrides:

getParent in class ComponentImpl

Returns:

the parent of this component

canContribute

public boolean canContribute()

Description copied from interface: ComponentEx

Returns true if this component can contribute visible parts to plot rendering artifact when this component is visible. Subcomponents are not considered.

Specified by:

canContribute in interface ComponentEx

Overrides:

canContribute in class ComponentImpl

Returns:

the indicator

setVisible

public void setVisible(boolean visible)

Description copied from interface: PComponent

Shows or hides this component depending on the value of parameter b.

Specified by:

setVisible in interface PComponent

Overrides:

setVisible in class ComponentImpl

Parameters:

visible - if true, shows this component; otherwise, hides this component

See Also:

PComponent.isVisible()

getLocation

public java.awt.geom.Point2D getLocation()

Description copied from interface: Title

Gets the location of this title.

Specified by:

getLocation in interface PComponent

Specified by:

getLocation in interface Title

Returns:

an instance of Point representing the base point of this title

setLocation

public final void setLocation(java.awt.geom.Point2D p)

Description copied from interface: Title

Moves this title to a new location.

Notice: This method should be called when the position is null, otherwise the behavior is not defined.

Specified by:

setLocation in interface MovableComponent

Specified by:

setLocation in interface Title

Parameters:

p - the base point of the title

setLocation

public void setLocation(double locX,
                        double locY)

Description copied from interface: MovableComponent

Moves this component to a new location.

Specified by:

setLocation in interface MovableComponent

Parameters:

locX - the x-coordinate of the new location

locY - the y-coordinate of the new location

thisEffectiveColorChanged

public void thisEffectiveColorChanged()

Description copied from interface: ComponentEx

Called when setColor() or parentEffectiveColorChanged() change the effective color of this component.

Specified by:

thisEffectiveColorChanged in interface ComponentEx

thisEffectiveFontChanged

public void thisEffectiveFontChanged()

Description copied from interface: ComponentEx

Called when setFontXxx() or parentEffectiveFontChanged() change the effective font of this component.

Specified by:

thisEffectiveFontChanged in interface ComponentEx

getText

public java.lang.String getText()

Description copied from interface: TextComponent

Returns the text string.

Specified by:

getText in interface TextComponent

Returns:

a String

setText

public void setText(java.lang.String text)

Description copied from interface: TextComponent

Defines the single line of text to be displayed. The string can be in TeX-like syntax. A pair of "$" mark into math mode and out math mode. In math mode, Greek letter can be inputed as \alpha, \beta, etc. Superscripts (up high) and subscripts (down low) can be inputed by using "^" and "_". Notice that ^ and _ apply only to the next single character. If you want several things to be superscripted or subscripted, just enclose them in braces. eg: "plain text $x_\alpha^{2y}$".

Specified by:

setText in interface TextComponent

getTextModel

public MathElement getTextModel()

setTextModel

public void setTextModel(MathElement model)

getHAlign

public HAlign getHAlign()

Description copied from interface: Title

Get the horizontal alignment.

Specified by:

getHAlign in interface TextComponent

Specified by:

getHAlign in interface Title

Returns:

the horizontal alignment.

setHAlign

public void setHAlign(HAlign hAlign)

Description copied from interface: Title

Set the horizontal alignment. The alignment can be LEFT, CENTER, or RIGHT. eg, LEFT means the base point is on the left of this title.

Notice: This method should be called when the position is null, otherwise the behavior is not defined.

Specified by:

setHAlign in interface TextComponent

Specified by:

setHAlign in interface Title

Parameters:

hAlign - horizontal alignment.

getVAlign

public VAlign getVAlign()

Description copied from interface: Title

Get the vertical alignment.

Specified by:

getVAlign in interface TextComponent

Specified by:

getVAlign in interface Title

Returns:

the vertical alignment.

setVAlign

public void setVAlign(VAlign vAlign)

Description copied from interface: Title

Set the vertical alignment. The alignment can be TOP, MIDDLE, or BOTTOM. eg, TOP means the base point is on the top of this title.

Notice: This method should be called when the position is null, otherwise the behavior is not defined.

Specified by:

setVAlign in interface TextComponent

Specified by:

setVAlign in interface Title

Parameters:

vAlign - The vertical alignment.

getSize

public java.awt.geom.Dimension2D getSize()

Description copied from interface: PComponent

Returns the paper size of this component.

Specified by:

getSize in interface PComponent

Returns:

getPosition

public TitlePosition getPosition()

Description copied from interface: Title

Gets the current position of this title in a layer.

Specified by:

getPosition in interface Title

Returns:

the position.

setPosition

public void setPosition(TitlePosition position)

Description copied from interface: Title

Sets the position of this title. Possible value is FREE, TOPLEFT, TOPCENTER, TOPRIGHT, BOTTOMLEFT, BOTTOMCENTER, BOTTOMRIGHT. Only when position is FREE, the title can be located by Title.setLocation(Point2D), #setHAlign(), #setVAlign() .

Specified by:

setPosition in interface Title

Parameters:

position - the position of this title.

getGapFactor

public double getGapFactor()

Description copied from interface: Title

Returns the ratio of gap to its height. The default value is 1/4.

Specified by:

getGapFactor in interface Title

Returns:

the gap factor

setGapFactor

public void setGapFactor(double factor)

Description copied from interface: Title

Sets the ratio of gap to its height. The gap is under the title when its position is TOPLEFT, TOPCENTER, TOPRIGHT. The gap is above the title when its position is BOTTOMLEFT, BOTTOMCENTER, BOTTOMRIGHT.

Specified by:

setGapFactor in interface Title

getBounds

public java.awt.geom.Rectangle2D getBounds()

Description copied from interface: PComponent

Returns the paper bounds relative to its location. The units of bounds is pt (1/72 inch)

Specified by:

getBounds in interface PComponent

Overrides:

getBounds in class ComponentImpl

Returns:

the paper bounds of this component.

calcSize

public void calcSize()

Description copied from interface: TitleEx

Called by plot to calculate size of this title.

Specified by:

calcSize in interface TitleEx

copyFrom

public void copyFrom(ElementEx src)

Description copied from interface: ElementEx

Copies all properties from given src to this element. Notice properties of sub-elements are not copied over.

Specified by:

copyFrom in interface ElementEx

Overrides:

copyFrom in class ComponentImpl

Parameters:

src - the src

draw

public void draw(java.awt.Graphics2D g)

Description copied from interface: ComponentEx

Draw this component only. All its children is not drawn.

Specified by:

draw in interface ComponentEx

Parameters:

g - to the Graphics2D drawing. The transformation of this component is not applied.