org.jplot2d.element.impl

Class AxisTitleImpl

java.lang.Object

org.jplot2d.element.impl.ElementImpl

org.jplot2d.element.impl.AxisTitleImpl

All Implemented Interfaces:

AxisTitle, Element, AxisTitleEx, ElementEx

public class AxisTitleImpl
extends ElementImpl
implements AxisTitleEx

Constructor Summary

Constructors

Constructor and Description
AxisTitleImpl()

Method Summary

Modifier and Type	Method and Description
void	copyFrom(ElementEx src) Copies all properties from given src to this element.
void	draw(java.awt.Graphics2D g, double x, double y) Draw this component only.
java.awt.Color	getColor() Gets the foreground color of this component.
java.awt.Font	getEffectiveFont() Returns the effective font of this axis title.
java.lang.String	getFontName() Returns the name of the font.
float	getFontScale() Returns the scale apply to parent's font size when font size is NaN.
float	getFontSize() Returns the Font size.
int	getFontStyle() Returns the style of the font.
java.lang.String	getId() Returns the id string of this element
InvokeStep	getInvokeStepFormParent() Return the invoke step to get this object from its parent.
AxisEx	getParent() Gets the parent of this component.
java.awt.geom.Dimension2D	getSize() Returns the title size.
java.lang.String	getText() Returns the text string.
MathElement	getTextModel() Returns the math model of this component.
boolean	isVisible() Determines whether this title should be visible when its parent is visible.
void	setColor(java.awt.Color color) Sets the foreground color of this component.
void	setFont(java.awt.Font font) Sets the font name, style and size for this component.
void	setFontName(java.lang.String name) Apply the new font with the given name
void	setFontScale(float scale) Sets the scale apply to parent's font size when font size is NaN.
void	setFontSize(float size) Sets a new size of the string.
void	setFontStyle(int style) Apply a new style to the font.
void	setText(java.lang.String text) Defines the single line of text to be displayed.
void	setTextModel(MathElement model) Sets the math model of this component.
void	setVAlign(VAlign vAlign) Set the vertical alignment.
void	setVisible(boolean visible) Shows or hides this title depending on the value of parameter b.

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

copyStructure, 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.impl.ElementEx

copyStructure, getFullId, notify, setParent

Methods inherited from interface org.jplot2d.element.Element

getEnvironment

Constructor Detail

AxisTitleImpl

public AxisTitleImpl()

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 AxisEx getParent()

Description copied from interface: Element

Gets the parent of this component.

Specified by:

getParent in interface Element

Specified by:

getParent in interface ElementEx

Overrides:

getParent in class ElementImpl

Returns:

the parent of this component

isVisible

public boolean isVisible()

Description copied from interface: AxisTitle

Determines whether this title should be visible when its parent is visible. AxisTitle are initially visible.

Specified by:

isVisible in interface AxisTitle

Returns:

true if the title is visible, false otherwise

See Also:

AxisTitle.setVisible(boolean)

setVisible

public void setVisible(boolean visible)

Description copied from interface: AxisTitle

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

Specified by:

setVisible in interface AxisTitle

Parameters:

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

See Also:

AxisTitle.isVisible()

getColor

public java.awt.Color getColor()

Description copied from interface: AxisTitle

Gets the foreground color of this component.

Specified by:

getColor in interface AxisTitle

Returns:

this component's foreground color; if this component does not have a foreground color, the foreground color of its parent is returned

See Also:

AxisTitle.setColor(java.awt.Color)

setColor

public void setColor(java.awt.Color color)

Description copied from interface: AxisTitle

Sets the foreground color of this component.

Specified by:

setColor in interface AxisTitle

Parameters:

color - the color to become this component's foreground color; if this parameter is null then this component will inherit the foreground color of its parent

See Also:

AxisTitle.getColor()

getFontName

public java.lang.String getFontName()

Description copied from interface: AxisTitle

Returns the name of the font.

Specified by:

getFontName in interface AxisTitle

Returns:

the name of the font.

setFontName

public void setFontName(java.lang.String name)

Description copied from interface: AxisTitle

Apply the new font with the given name

Specified by:

setFontName in interface AxisTitle

Parameters:

name - the font name.

getFontStyle

public int getFontStyle()

Description copied from interface: AxisTitle

Returns the style of the font. The style can be PLAIN, BOLD, ITALIC, or BOLD+ITALIC.

Specified by:

getFontStyle in interface AxisTitle

Returns:

the style of the font

See Also:

Font

setFontStyle

public void setFontStyle(int style)

Description copied from interface: AxisTitle

Apply a new style to the font. The style can be PLAIN, BOLD, ITALIC, or BOLD+ITALIC.

Specified by:

setFontStyle in interface AxisTitle

Parameters:

style - the style to apply

See Also:

Font

getFontSize

public float getFontSize()

Description copied from interface: AxisTitle

Returns the Font size.

Specified by:

getFontSize in interface AxisTitle

Returns:

the font size.

setFontSize

public void setFontSize(float size)

Description copied from interface: AxisTitle

Sets a new size of the string.

Specified by:

setFontSize in interface AxisTitle

Parameters:

size - the new size of the font.

getFontScale

public float getFontScale()

Description copied from interface: AxisTitle

Returns the scale apply to parent's font size when font size is NaN.

Specified by:

getFontScale in interface AxisTitle

Returns:

the font scale.

setFontScale

public void setFontScale(float scale)

Description copied from interface: AxisTitle

Sets the scale apply to parent's font size when font size is NaN.

Specified by:

setFontScale in interface AxisTitle

Parameters:

scale - the scale

setFont

public void setFont(java.awt.Font font)

Description copied from interface: AxisTitle

Sets the font name, style and size for this component.

Specified by:

setFont in interface AxisTitle

Parameters:

font - the desired Font for this component

getEffectiveFont

public java.awt.Font getEffectiveFont()

Description copied from interface: AxisTitle

Returns the effective font of this axis title.

Specified by:

getEffectiveFont in interface AxisTitle

Returns:

the effective font of this axis title

getText

public java.lang.String getText()

Description copied from interface: AxisTitle

Returns the text string.

Specified by:

getText in interface AxisTitle

Returns:

a String

setText

public void setText(java.lang.String text)

Description copied from interface: AxisTitle

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 AxisTitle

getTextModel

public MathElement getTextModel()

Description copied from interface: AxisTitleEx

Returns the math model of this component.

Specified by:

getTextModel in interface AxisTitleEx

Returns:

the math model

setTextModel

public void setTextModel(MathElement model)

Description copied from interface: AxisTitleEx

Sets the math model of this component.

Specified by:

setTextModel in interface AxisTitleEx

Parameters:

model - the math model

setVAlign

public void setVAlign(VAlign vAlign)

Description copied from interface: AxisTitleEx

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

Specified by:

setVAlign in interface AxisTitleEx

Parameters:

vAlign - the vertical alignment.

getSize

public java.awt.geom.Dimension2D getSize()

Description copied from interface: AxisTitleEx

Returns the title size. The units of bounds is pt (1/72 inch)

Specified by:

getSize in interface AxisTitleEx

Returns:

the paper bounds of this title.

draw

public void draw(java.awt.Graphics2D g,
                 double x,
                 double y)

Description copied from interface: AxisTitleEx

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

Specified by:

draw in interface AxisTitleEx

Parameters:

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

x - the x position

y - the y position

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 ElementImpl

Parameters:

src - the src