org.jplot2d.element.impl

Class AxisTransformImpl

java.lang.Object

org.jplot2d.element.impl.ElementImpl

org.jplot2d.element.impl.AxisTransformImpl

All Implemented Interfaces:

AxisTransform, Element, AxisTransformEx, ElementEx, Joinable

public class AxisTransformImpl
extends ElementImpl
implements AxisTransformEx

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_MARGIN_FACTOR The default margin factor (used for both lower and upper margins)

Constructor Summary

Constructors

Constructor and Description
AxisTransformImpl()

Method Summary

Modifier and Type	Method and Description
void	addLayer(LayerEx layer) Called when a layer attach to this viewport axis
void	addTickManager(AxisTickManagerEx tickManager)
void	changeTransformType(TransformType txfType)
void	copyFrom(ElementEx src) Copies all properties from given src to this element.
AxisTransformEx	copyStructure(java.util.Map<ElementEx,ElementEx> orig2copyMap) Create a structural copy of this element and put them into orig2copyMap.
Range	expandRangeToTick(Range ur)
Range	getCoreRange() Return the core range of the AxisTransform.
java.lang.String	getFullId() Returns the full id of this component.
java.lang.String	getId() Returns the id string of this element
InvokeStep	getInvokeStepFormParent() Return the invoke step to get this object from its parent.
LayerEx[]	getLayers() Returns all layers attaching to this AxisTransform.
AxisRangeLockGroupEx	getLockGroup() Returns the lock group to that this AxisTransform belongs.
double	getMarginFactor() Returns the factor that the margin will be appended to range
NormalTransform	getNormalTransform() Returns the normal transform of this AxisTransform
AxisTickManagerEx	getParent() Gets the parent of this component.
ElementEx	getPrim() Returns the primary referencer.
Range	getRange() Return the range of the AxisTransform.
AxisTickManagerEx[]	getTickManagers() Returns all axis tick managers belongs to this range manager.
TransformType	getTransform() Returns the transform type
AxisType	getType() Return the type of this axis.
int	indexOfTickManager(AxisTickManagerEx tickManager)
boolean	isAutoMargin() Returns true if the margin is extended to an axis major tick automatically.
boolean	isInverted() Returns true if this AxisTransform is inverted.
void	linkLayer(LayerEx layer)
void	notify(Notice msg) Element call this method to notify message to its parent.
void	removeLayer(LayerEx layer) Called when a layer detach from this viewport axis
void	removeTickManager(AxisTickManagerEx tickManager)
void	setAutoMargin(boolean autoMargin) Controls if the the margin is extended to an axis major tick automatically.
void	setCoreRange(Range crange) Set the core range of the AxisTransform.
void	setInverted(boolean flag) Sets false to make this AxisTransform have "normal" displaying, or true to have "inverted" displaying.
void	setLockGroup(AxisRangeLockGroup group) Join an axis lock group.
void	setMarginFactor(double factor) Sets the factor that the margin will be appended to range
void	setNormalTransfrom(NormalTransform ntf) Sets the normal transform of this axis
void	setRange(Range urange) Set the actual range displayed in the AxisTransform.
void	setTransform(TransformType txfType) Sets the transform type
void	setType(AxisType type) Set the type of the axis.

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

getEnvironment, 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

setParent

Methods inherited from interface org.jplot2d.element.Element

getEnvironment

Field Detail

DEFAULT_MARGIN_FACTOR

public static final double DEFAULT_MARGIN_FACTOR

The default margin factor (used for both lower and upper margins)

See Also:

Constant Field Values

Constructor Detail

AxisTransformImpl

public AxisTransformImpl()

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

getFullId

public java.lang.String getFullId()

Description copied from interface: ElementEx

Returns the full id of this component. The full id is composed of series of ids concatenated with dots. The 1st id is the id of this element, the 2nd id is the id of the parent of this element, etc, until the root plot.

Specified by:

getFullId in interface ElementEx

Overrides:

getFullId in class ElementImpl

Returns:

the full id of this component

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

Description copied from interface: Element

Gets the parent of this component.

Specified by:

getParent in interface Element

Specified by:

getParent in interface AxisTransformEx

Specified by:

getParent in interface ElementEx

Overrides:

getParent in class ElementImpl

Returns:

the parent of this component

getPrim

public ElementEx getPrim()

Description copied from interface: Joinable

Returns the primary referencer.

Specified by:

getPrim in interface Joinable

Returns:

the primary referencer

notify

public void notify(Notice msg)

Description copied from interface: ElementEx

Element call this method to notify message to its parent.

Specified by:

notify in interface ElementEx

Overrides:

notify in class ElementImpl

Parameters:

msg - the notice message

isInverted

public boolean isInverted()

Description copied from interface: AxisTransform

Returns true if this AxisTransform is inverted.

Specified by:

isInverted in interface AxisTransform

Returns:

true if this AxisTransform is inverted

setInverted

public void setInverted(boolean flag)

Description copied from interface: AxisTransform

Sets false to make this AxisTransform have "normal" displaying, or true to have "inverted" displaying.

Specified by:

setInverted in interface AxisTransform

Parameters:

flag - if flag is true this AxisTransform is inverted, if flag is false this AxisTransform is normal

isAutoMargin

public boolean isAutoMargin()

Description copied from interface: AxisTransform

Returns true if the margin is extended to an axis major tick automatically. The minimal margin is controlled by AxisTransform.getMarginFactor()

Specified by:

isAutoMargin in interface AxisTransform

Returns:

true if the margin is auto-selected

setAutoMargin

public void setAutoMargin(boolean autoMargin)

Description copied from interface: AxisTransform

Controls if the the margin is extended to an axis major tick automatically.

Specified by:

setAutoMargin in interface AxisTransform

Parameters:

autoMargin - the switch

getMarginFactor

public double getMarginFactor()

Description copied from interface: AxisTransform

Returns the factor that the margin will be appended to range

Specified by:

getMarginFactor in interface AxisTransform

Returns:

the margin factor

setMarginFactor

public void setMarginFactor(double factor)

Description copied from interface: AxisTransform

Sets the factor that the margin will be appended to range

Specified by:

setMarginFactor in interface AxisTransform

Parameters:

factor - the margin factor

getType

public AxisType getType()

Description copied from interface: AxisTransform

Return the type of this axis.

Specified by:

getType in interface AxisTransform

Returns:

the type of this axis

setType

public void setType(AxisType type)

Description copied from interface: AxisTransform

Set the type of the axis. An axis type can only be changed when it dosn't lock with other axes.

Specified by:

setType in interface AxisTransform

Parameters:

type - the axis type

getTransform

public TransformType getTransform()

Description copied from interface: AxisTransform

Returns the transform type

Specified by:

getTransform in interface AxisTransform

Returns:

the transform type

setTransform

public void setTransform(TransformType txfType)

Description copied from interface: AxisTransform

Sets the transform type

Specified by:

setTransform in interface AxisTransform

Parameters:

txfType - the transform type

changeTransformType

public void changeTransformType(TransformType txfType)

Specified by:

changeTransformType in interface AxisTransformEx

getLockGroup

public AxisRangeLockGroupEx getLockGroup()

Description copied from interface: AxisTransform

Returns the lock group to that this AxisTransform belongs. A AxisTransform must has a lock group, which have this AxisTransform at least.

Specified by:

getLockGroup in interface AxisTransform

Specified by:

getLockGroup in interface AxisTransformEx

Returns:

setLockGroup

public void setLockGroup(AxisRangeLockGroup group)

Description copied from interface: AxisTransform

Join an axis lock group. The lock group must exist in the same environment, otherwise an exception will be thrown.

Specified by:

setLockGroup in interface AxisTransform

Parameters:

group - the lock group to join to.

getNormalTransform

public NormalTransform getNormalTransform()

Description copied from interface: AxisTransform

Returns the normal transform of this AxisTransform

Specified by:

getNormalTransform in interface AxisTransform

Returns:

the normal transform

setNormalTransfrom

public void setNormalTransfrom(NormalTransform ntf)

Description copied from interface: AxisTransformEx

Sets the normal transform of this axis

Specified by:

setNormalTransfrom in interface AxisTransformEx

Parameters:

ntf - the normal transform

getTickManagers

public AxisTickManagerEx[] getTickManagers()

Description copied from interface: AxisTransform

Returns all axis tick managers belongs to this range manager.

Specified by:

getTickManagers in interface AxisTransform

Specified by:

getTickManagers in interface AxisTransformEx

Returns:

all axes tick managers belongs to this range manager.

addTickManager

public void addTickManager(AxisTickManagerEx tickManager)

Specified by:

addTickManager in interface AxisTransformEx

removeTickManager

public void removeTickManager(AxisTickManagerEx tickManager)

Specified by:

removeTickManager in interface AxisTransformEx

indexOfTickManager

public int indexOfTickManager(AxisTickManagerEx tickManager)

Specified by:

indexOfTickManager in interface AxisTransformEx

getLayers

public LayerEx[] getLayers()

Description copied from interface: AxisTransform

Returns all layers attaching to this AxisTransform.

Specified by:

getLayers in interface AxisTransform

Specified by:

getLayers in interface AxisTransformEx

Returns:

addLayer

public void addLayer(LayerEx layer)

Description copied from interface: AxisTransformEx

Called when a layer attach to this viewport axis

Specified by:

addLayer in interface AxisTransformEx

Parameters:

layer - the layer

removeLayer

public void removeLayer(LayerEx layer)

Description copied from interface: AxisTransformEx

Called when a layer detach from this viewport axis

Specified by:

removeLayer in interface AxisTransformEx

Parameters:

layer - the layer

linkLayer

public void linkLayer(LayerEx layer)

Specified by:

linkLayer in interface AxisTransformEx

getCoreRange

public Range getCoreRange()

Description copied from interface: AxisTransform

Return the core range of the AxisTransform. The returned range will be negative (start > end) if this AxisTransform is inverted.

Specified by:

getCoreRange in interface AxisTransform

Returns:

the core range

setCoreRange

public void setCoreRange(Range crange)

Description copied from interface: AxisTransform

Set the core range of the AxisTransform. The range will expand according to the settings of autoMargin and marginFactor, and derive an actual range. The given range can be positive (start < end) or negative (start > end). It has not effect on the inverted property. All locked axes will follow the change of this axis.

If user want set actual range directly by AxisTransform.setRange(Range), The coreRange will be set to null automatically.

Specified by:

setCoreRange in interface AxisTransform

Parameters:

crange - the core range to be set

getRange

public Range getRange()

Description copied from interface: AxisTransform

Return the range of the AxisTransform. The returned range will be negative (start > end) if this AxisTransform is inverted.

Specified by:

getRange in interface AxisTransform

Returns:

the actual range displayed

setRange

public void setRange(Range urange)

Description copied from interface: AxisTransform

Set the actual range displayed in the AxisTransform. The given range can be positive (start < end) or negative (start > end). It has not effect on the inverted property. All locked axes will follow the change of this axis.

The coreRange is set to null after calling this method.

Specified by:

setRange in interface AxisTransform

Parameters:

urange - the actual range to be set.

expandRangeToTick

public Range expandRangeToTick(Range ur)

Specified by:

expandRangeToTick in interface AxisTransformEx

copyStructure

public AxisTransformEx copyStructure(java.util.Map<ElementEx,ElementEx> orig2copyMap)

Description copied from interface: ElementEx

Create a structural copy of this element and put them into orig2copyMap. All properties are not copied. The parent of the copy are not set by this method.

Specified by:

copyStructure in interface ElementEx

Overrides:

copyStructure in class ElementImpl

Parameters:

orig2copyMap - original element to copy map

Returns:

the structural copy of this element

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