com.telerik.widget.chart.engine.elementTree

Class ChartElement

java.lang.Object

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

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

com.telerik.widget.chart.engine.elementTree.ChartElement

Direct Known Subclasses:

AxisModel, ChartAnnotationModel, ChartAreaModel, ChartGridModel, ChartPlotAreaModel, ChartSeriesModel

public abstract class ChartElement
extends ChartNode

Base class for nodes that may have children.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ChartElement.Predicate<T>

Field Summary

Fields

Modifier and Type	Field and Description
NodeCollection	children

Fields inherited from class com.telerik.widget.chart.engine.elementTree.ChartNode

PROPERTY_CHANGED_MESSAGE, PROPERTY_CHANGING_MESSAGE, trackPropertyChanged, trackPropertyChanging

Method Summary

Modifier and Type	Method and Description
ModifyChildrenResult	canAddChild(ChartNode child) Gets a ModifyChildrenResult value that determines if a child can be added to this element.
Iterable<ChartNode>	enumDescendants() When iterated over returns all descendants in TreeTraversalMode.DEPTH_FIRST order.
Iterable<ChartNode>	enumDescendants(ChartElement.Predicate<ChartNode> predicate, TreeTraversalMode traverseMode) When iterated over in the given TreeTraversalMode, returns children that match the provided predicate.
Iterable<ChartNode>	enumDescendants(TreeTraversalMode traverseMode) When iterated over returns all descendants in the provided TreeTraversalMode order.
<T extends ChartElement> T	findAncestor(Class<T> clazz) Searches up the parent chain and returns the first parent of type T.
ChartNode	findDescendant(ChartElement.Predicate<ChartNode> criteria) Searches down the subtree of elements, using breadth-first approach, and returns the first descendant of type T that matches the provided criteria.
ChartElementPresenter	getPresenter() Gets the ChartElementPresenter instance whichrepresents the visual element in which this ChartNode is visualised.
boolean	isAncestorOf(ChartNode node) Gets a boolean value that determines whether a given element resides in the element hierarchy of this element.
void	setPresenter(ChartElementPresenter presenter) Assigns the given ChartElementPresenter to this element.

Methods inherited from class com.telerik.widget.chart.engine.elementTree.ChartNode

applyLayoutRounding, arrange, arrange, chartArea, clearValue, collectionIndex, getLayoutSlot, getNodeState, getParent, index, invalidate, isTreeLoaded, isVisible, load, setIsVisible, setParent, setValue

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

children

public NodeCollection children

Method Detail

getPresenter

public ChartElementPresenter getPresenter()

Description copied from class: ChartNode

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

Overrides:

getPresenter in class ChartNode

Returns:

the ChartElementPresenter instance.

setPresenter

public void setPresenter(ChartElementPresenter presenter)

Assigns the given ChartElementPresenter to this element.

Parameters:

presenter - The presenter.

findAncestor

public <T extends ChartElement> T findAncestor(Class<T> clazz)

Searches up the parent chain and returns the first parent of type T.

Type Parameters:

T - The type of parent to search for.

Returns:

The first parent of type T.

isAncestorOf

public boolean isAncestorOf(ChartNode node)

Gets a boolean value that determines whether a given element resides in the element hierarchy of this element.

Parameters:

node - The node to check.

findDescendant

public ChartNode findDescendant(ChartElement.Predicate<ChartNode> criteria)

Searches down the subtree of elements, using breadth-first approach, and returns the first descendant of type T that matches the provided criteria.

Parameters:

criteria - The criteria that determines which descendant to return.

enumDescendants

public Iterable<ChartNode> enumDescendants()

When iterated over returns all descendants in TreeTraversalMode.DEPTH_FIRST order.

enumDescendants

public Iterable<ChartNode> enumDescendants(TreeTraversalMode traverseMode)

When iterated over returns all descendants in the provided TreeTraversalMode order.

Parameters:

traverseMode - The tree traversal mode.

enumDescendants

public Iterable<ChartNode> enumDescendants(ChartElement.Predicate<ChartNode> predicate,
                                           TreeTraversalMode traverseMode)

When iterated over in the given TreeTraversalMode, returns children that match the provided predicate.

Parameters:

predicate - The predicate to apply to children nodes.

traverseMode - The tree traversal mode.

canAddChild

public ModifyChildrenResult canAddChild(ChartNode child)

Gets a ModifyChildrenResult value that determines if a child can be added to this element.

Parameters:

child - The child to be considered.