com.telerik.widget.chart.engine.elementTree

Class ChartNode

java.lang.Object

com.telerik.widget.chart.engine.propertyStore.PropertyBagObject

com.telerik.widget.chart.engine.elementTree.ChartNode

Direct Known Subclasses:

AxisTickModel, ChartElement, ContentNode, DataPoint

public abstract class ChartNode
extends PropertyBagObject

This class is a base for all models that comprise the Chart and are used by the Chart engine to calculate the coordinates and bounds of the visual elements.

Field Summary

Fields

Modifier and Type	Field and Description
static int	PROPERTY_CHANGED_MESSAGE
static int	PROPERTY_CHANGING_MESSAGE
boolean	trackPropertyChanged
boolean	trackPropertyChanging

Method Summary

Modifier and Type	Method and Description
void	applyLayoutRounding() Applies layout snapping and corrects rounding errors.
RadRect	arrange(RadRect rect) Arranges the current ChartNode into a rectangle depicted by the provided RadRect instance.
RadRect	arrange(RadRect rect, boolean shouldRoundLayout) Arranges the current ChartNode into a rectangle depicted by the provided RadRect instance and rounds the layout parameters if required.
ChartAreaModel	chartArea() Returns an instance of the ChartAreaModel class representing the chart model which this node is part of.
boolean	clearValue(int key) Clears the current value for the specified property key.
int	collectionIndex() Gets the index of the ChartNode instance in its parent ElementCollection.
RadRect	getLayoutSlot() Gets an instance of the RadRect class which depicts the layout slot of the current ChartNode.
NodeState	getNodeState() Gets a value of the NodeState enum which determines the state of the current ChartNode.
ChartElement	getParent() Gets the parent element of the current ChartNode.
ChartElementPresenter	getPresenter() Gets the ChartElementPresenter instance whichrepresents the visual element in which this ChartNode is visualised.
int	index() Gets the index of the ChartNode instance in its parent NodeCollection.
void	invalidate() Invalidates the layout parameters of the current ChartNode instance in the context of the owning chart area.
boolean	isTreeLoaded() Gets a value determining whether the node three of the parent chart is been loaded.
boolean	isVisible() Returns a boolean value indicating whether the current node is visible and takes part in the chart layout.
void	load(LoadContext context) Loads the current ChartNode into the provided LoadContext instance.
void	setIsVisible(boolean value) Sets a boolean value indicating whether the current node is visible and takes part in the chart layout.
void	setParent(ChartElement value) Initializes the parent of the current ChartNode to the specified ChartElement.
boolean	setValue(int key, Object value) Sets the property specified by the provided key to the provided object.

Methods inherited from class com.telerik.widget.chart.engine.propertyStore.PropertyBagObject

getTypedValue, getValue, isLocalValue

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_CHANGING_MESSAGE

public static final int PROPERTY_CHANGING_MESSAGE

PROPERTY_CHANGED_MESSAGE

public static final int PROPERTY_CHANGED_MESSAGE

trackPropertyChanging

public boolean trackPropertyChanging

trackPropertyChanged

public boolean trackPropertyChanged

Method Detail

isVisible

public boolean isVisible()

Returns a boolean value indicating whether the current node is visible and takes part in the chart layout.

Returns:

true if the node is visible, otherwise false.

setIsVisible

public void setIsVisible(boolean value)

Sets a boolean value indicating whether the current node is visible and takes part in the chart layout.

Parameters:

value - true if the ChartNode instance is visible, otherwise false.

chartArea

public ChartAreaModel chartArea()

Returns an instance of the ChartAreaModel class representing the chart model which this node is part of.

Returns:

the ChartAreaModel model.

index

public int index()

Gets the index of the ChartNode instance in its parent NodeCollection.

Returns:

the index of the ChartNode.

collectionIndex

public int collectionIndex()

Gets the index of the ChartNode instance in its parent ElementCollection.

Returns:

the index of the ChartNode.

getNodeState

public NodeState getNodeState()

Gets a value of the NodeState enum which determines the state of the current ChartNode.

Returns:

the state of the ChartNode.

isTreeLoaded

public boolean isTreeLoaded()

Gets a value determining whether the node three of the parent chart is been loaded.

Returns:

true if the tree is loaded, otherwise false.

getLayoutSlot

public RadRect getLayoutSlot()

Gets an instance of the RadRect class which depicts the layout slot of the current ChartNode.

Returns:

the layout slot of the ChartNode.

getParent

public ChartElement getParent()

Gets the parent element of the current ChartNode.

Returns:

an instance of the ChartElement class representing the parent of the current ChartNode.

setParent

public void setParent(ChartElement value)

Initializes the parent of the current ChartNode to the specified ChartElement.

Parameters:

value - the ChartElement instance which represents the parent of this ChartNode.

getPresenter

public ChartElementPresenter getPresenter()

Gets the ChartElementPresenter instance whichrepresents the visual element in which this ChartNode is visualised.

Returns:

the ChartElementPresenter instance.

arrange

public RadRect arrange(RadRect rect)

Arranges the current ChartNode into a rectangle depicted by the provided RadRect instance.

Parameters:

rect - the RadRect instance that represents the bounds in which to arrange the ChartNode.

Returns:

an instance of the RadRect class that represents the ChartNode bounds after the arrange has been done.

arrange

public RadRect arrange(RadRect rect,
                       boolean shouldRoundLayout)

Arranges the current ChartNode into a rectangle depicted by the provided RadRect instance and rounds the layout parameters if required.

Parameters:

rect - the RadRect instance that represents the bounds in which to arrange the ChartNode.

shouldRoundLayout - true if layout coordinates rounding is required, otherwise false.

Returns:

an instance of the RadRect class that represents the ChartNode bounds after the arrange has been done.

invalidate

public void invalidate()

Invalidates the layout parameters of the current ChartNode instance in the context of the owning chart area.

applyLayoutRounding

public void applyLayoutRounding()

Applies layout snapping and corrects rounding errors.

setValue

public boolean setValue(int key,
                        Object value)

Description copied from class: PropertyBagObject

Sets the property specified by the provided key to the provided object.

Overrides:

setValue in class PropertyBagObject

Parameters:

key - the key of the property to set.

value - the value of the property.

Returns:

true if the property has been successfully set, otherwise false.

clearValue

public boolean clearValue(int key)

Description copied from class: PropertyBagObject

Clears the current value for the specified property key.

Overrides:

clearValue in class PropertyBagObject

Parameters:

key - the key of the property to clear.

Returns:

true if the property has been successfully cleared, otherwise false.

load

public void load(LoadContext context)

Loads the current ChartNode into the provided LoadContext instance.

Parameters:

context - the LoadContext into which the current ChartNode will be loaded.