org.jplot2d.element.impl

Class LayerImpl

java.lang.Object

org.jplot2d.element.impl.ElementImpl

org.jplot2d.element.impl.ComponentImpl

org.jplot2d.element.impl.ContainerImpl

org.jplot2d.element.impl.LayerImpl

All Implemented Interfaces:

Element, ComponentEx, ContainerEx, ElementEx, LayerEx, Layer, PComponent

public class LayerImpl
extends ContainerImpl
implements LayerEx

Constructor Summary

Constructors

Constructor and Description
LayerImpl()

Method Summary

Modifier and Type	Method and Description
void	addAnnotation(Annotation annotation) Add a new annotation to this layer.
void	addGraph(Graph graph) Adds a graph to this layer.
boolean	canContribute() Returns true if this component can contribute visible parts to plot rendering artifact when this component is visible.
LayerEx	copyStructure(java.util.Map<ElementEx,ElementEx> orig2copyMap) Create a structural copy of this element and put them into orig2copyMap.
Annotation	getAnnotation(int idx) Returns the annotation.
AnnotationEx[]	getAnnotations() Returns all the annotations in this layer.
ComponentEx[]	getComponents() Returns the components in this container.
Graph	getGraph(int index) Returns the graph on the given index.
GraphEx[]	getGraphs() Returns all graph of this layer.
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() Returns the location of this component.
java.util.Map<Element,Element>	getMooringMap() Returns a map to tell why this component cannot be removed from its container.
PaperTransform	getPaperTransform() Returns the paper transform of this component, which can be used to convert between device coordinate and paper coordinate of this component.
PlotEx	getParent() Gets the parent of this component.
java.lang.String	getShortId() Returns the short id of this layer.
java.awt.geom.Dimension2D	getSize() Returns the paper size of this component.
AxisTransformEx	getXAxisTransform() Returns the X axis to this layer attaching.
AxisTransformEx	getYAxisTransform() Returns the Y axis to this layer attaching.
int	indexOf(AnnotationEx annotation)
int	indexOf(GraphEx graph)
void	linkXAxisTransform(AxisTransformEx axt)
void	linkYAxisTransform(AxisTransformEx axt)
void	removeAnnotation(Annotation annotation) Remove the annotation from this layer.
void	removeGraph(Graph graph) Remove the graph from this layer.
void	setAxesTransform(AxisTransform xaxis, AxisTransform yaxis) Attach this layer to the given X/Y axis pair.
void	setXAxisTransform(AxisTransform axis) Attach this layer to the given X axis.
void	setYAxisTransform(AxisTransform axis) Attach this layer to the given Y axis.
void	transformChanged() Called by AxisTransformEx to notify that x/y transform is changed.

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

draw, thisEffectiveColorChanged, thisEffectiveFontChanged

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

addPropertyChangeListener, copyFrom, getBounds, getColor, getEffectiveColor, getEffectiveFont, getEffectiveFontName, getEffectiveFontSize, getEffectiveFontStyle, getFontName, getFontScale, getFontSize, getFontStyle, getSelectableBounds, getZOrder, isCacheable, isMovable, isRedrawNeeded, isSelectable, isVisible, parentEffectiveColorChanged, parentEffectiveFontChanged, removePropertyChangeListener, setCacheable, setColor, setFont, setFontName, setFontScale, setFontSize, setFontStyle, setMovable, setRedrawNeeded, setSelectable, setVisible, 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.impl.ComponentEx

draw, getEffectiveColor, getEffectiveFontName, getEffectiveFontSize, getEffectiveFontStyle, isMovable, isRedrawNeeded, parentEffectiveColorChanged, parentEffectiveFontChanged, setMovable, setRedrawNeeded, thisEffectiveColorChanged, thisEffectiveFontChanged

Methods inherited from interface org.jplot2d.element.PComponent

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

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

copyFrom, getFullId, notify, setParent

Methods inherited from interface org.jplot2d.element.Element

getEnvironment

Constructor Detail

LayerImpl

public LayerImpl()

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

getShortId

public java.lang.String getShortId()

Description copied from interface: LayerEx

Returns the short id of this layer. The short 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 but not include the root plot.

Specified by:

getShortId in interface LayerEx

Returns:

the short id of this layer.

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 LayerEx

Specified by:

getParent in interface Layer

Specified by:

getParent in interface PComponent

Overrides:

getParent in class ComponentImpl

Returns:

the parent of this component

getMooringMap

public java.util.Map<Element,Element> getMooringMap()

Description copied from interface: ComponentEx

Returns a map to tell why this component cannot be removed from its container. The key is the moored element, required by its value.

Specified by:

getMooringMap in interface ComponentEx

Overrides:

getMooringMap in class ComponentImpl

Returns:

a map. The key is the element required by its value.

getLocation

public java.awt.geom.Point2D getLocation()

Description copied from interface: PComponent

Returns the location of this component.

Specified by:

getLocation in interface PComponent

Returns:

the base point in its parent's paper coordinate space

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:

getPaperTransform

public PaperTransform getPaperTransform()

Description copied from interface: PComponent

Returns the paper transform of this component, which can be used to convert between device coordinate and paper coordinate of this component. The original point of paper coordinate is the location point of this component.

Returns null if the component is not added to a plot or not laid out

Specified by:

getPaperTransform in interface PComponent

Overrides:

getPaperTransform in class ComponentImpl

Returns:

the paper transform of this component

transformChanged

public void transformChanged()

Description copied from interface: LayerEx

Called by AxisTransformEx to notify that x/y transform is changed.

Specified by:

transformChanged in interface LayerEx

getComponents

public ComponentEx[] getComponents()

Description copied from interface: ContainerEx

Returns the components in this container.

Specified by:

getComponents in interface ContainerEx

Returns:

an array of sub-components

getGraph

public Graph getGraph(int index)

Description copied from interface: Layer

Returns the graph on the given index.

Specified by:

getGraph in interface Layer

Returns:

the graph on the given index

getGraphs

public GraphEx[] getGraphs()

Description copied from interface: Layer

Returns all graph of this layer.

Specified by:

getGraphs in interface LayerEx

Specified by:

getGraphs in interface Layer

Returns:

all graph of this layer.

addGraph

public void addGraph(Graph graph)

Description copied from interface: Layer

Adds a graph to this layer.

Specified by:

addGraph in interface Layer

Parameters:

graph - the graoh to be add.

removeGraph

public void removeGraph(Graph graph)

Description copied from interface: Layer

Remove the graph from this layer.

Specified by:

removeGraph in interface Layer

Parameters:

graph - the graph to be removed

indexOf

public int indexOf(GraphEx graph)

Specified by:

indexOf in interface LayerEx

getAnnotations

public AnnotationEx[] getAnnotations()

Description copied from interface: Layer

Returns all the annotations in this layer.

Specified by:

getAnnotations in interface LayerEx

Specified by:

getAnnotations in interface Layer

Returns:

all annotations in an array

getAnnotation

public Annotation getAnnotation(int idx)

Description copied from interface: Layer

Returns the annotation.

Specified by:

getAnnotation in interface Layer

Returns:

the annotation.

addAnnotation

public void addAnnotation(Annotation annotation)

Description copied from interface: Layer

Add a new annotation to this layer.

Specified by:

addAnnotation in interface Layer

Parameters:

annotation - the annotation to be added

removeAnnotation

public void removeAnnotation(Annotation annotation)

Description copied from interface: Layer

Remove the annotation from this layer.

Specified by:

removeAnnotation in interface Layer

Parameters:

annotation - the annotation to be removed

indexOf

public int indexOf(AnnotationEx annotation)

Specified by:

indexOf in interface LayerEx

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

getXAxisTransform

public AxisTransformEx getXAxisTransform()

Description copied from interface: Layer

Returns the X axis to this layer attaching.

Specified by:

getXAxisTransform in interface LayerEx

Specified by:

getXAxisTransform in interface Layer

Returns:

getYAxisTransform

public AxisTransformEx getYAxisTransform()

Description copied from interface: Layer

Returns the Y axis to this layer attaching.

Specified by:

getYAxisTransform in interface LayerEx

Specified by:

getYAxisTransform in interface Layer

Returns:

linkXAxisTransform

public void linkXAxisTransform(AxisTransformEx axt)

Specified by:

linkXAxisTransform in interface LayerEx

linkYAxisTransform

public void linkYAxisTransform(AxisTransformEx axt)

Specified by:

linkYAxisTransform in interface LayerEx

setXAxisTransform

public void setXAxisTransform(AxisTransform axis)

Description copied from interface: Layer

Attach this layer to the given X axis. When adding a layer to a plot, the axis must exist in the destination environment, otherwise an exception will be thrown.

Specified by:

setXAxisTransform in interface Layer

Parameters:

axis - axis transform

setYAxisTransform

public void setYAxisTransform(AxisTransform axis)

Description copied from interface: Layer

Attach this layer to the given Y axis. When adding a layer to a plot, the axis must exist in the destination environment, otherwise an exception will be thrown.

Specified by:

setYAxisTransform in interface Layer

Parameters:

axis - axis transform

setAxesTransform

public void setAxesTransform(AxisTransform xaxis,
                             AxisTransform yaxis)

Description copied from interface: Layer

Attach this layer to the given X/Y axis pair. When adding a layer to a plot, the X/Y axes must exist in the destination environment, otherwise an exception will be thrown.

Specified by:

setAxesTransform in interface Layer

Parameters:

xaxis - the x axis transform

yaxis - the y axis transform

copyStructure

public LayerEx 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 ComponentEx

Specified by:

copyStructure in interface ElementEx

Overrides:

copyStructure in class ComponentImpl

Parameters:

orig2copyMap - original element to copy map

Returns:

the structural copy of this element