com.telerik.widget.chart.engine.chartAreas

Class ChartAreaModel

java.lang.Object

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

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

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

com.telerik.widget.chart.engine.chartAreas.ChartAreaModel

Direct Known Subclasses:

ChartAreaModelWithAxes

public class ChartAreaModel
extends ChartElement

This class represents a non-visual model which contains all elements that comprise a Chart. This class is used by the drawing mechanism to visualize the chart elements. You are not supposed to use this class in your application.

Nested Class Summary

Nested classes/interfaces inherited from class com.telerik.widget.chart.engine.elementTree.ChartElement

ChartElement.Predicate<T>

Field Summary

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

children

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

PROPERTY_CHANGED_MESSAGE, PROPERTY_CHANGING_MESSAGE, trackPropertyChanged, trackPropertyChanging

Constructor Summary

Constructors

Constructor and Description
ChartAreaModel() Creates an instance of the ChartAreaModel class by initializing its plot area and messaging infrastructure.

Method Summary

Modifier and Type	Method and Description
void	beginUpdate() Locks the ChartAreaModel for performing state update calls.
ModifyChildrenResult	canAddChild(ChartNode child) Gets a ModifyChildrenResult value that determines if a child can be added to this element.
void	endUpdate(boolean refresh) Unlocks the ChartAreaModel thus allowing the processing of ChartNode updates and messages.
MessageDispatcher	getDispatcher() Gets the MessageDispatcher instance associated with this ChartAreaModel.
Iterable<String>	getNotLoadedReasons() Generates a collection of reasons describing why the chart could not be loaded.
ChartPlotAreaModel	getPlotArea() Gets an instance of the ChartPlotAreaModel class representing the part of the chart where the data is plotted.
ElementCollection<ChartSeriesModel>	getSeries() Gets a ElementCollection containing the currently available series in this ChartAreaModel.
ChartView	getView() Gets the current chart view.
void	invalidate(int flags) Invalidates the ChartAreaModel by specifying what types of calculations will be performed after validation.
void	invalidateNode(ChartNode node) Invalidates the state of the specified ChartNode and refreshes it.
boolean	isSuspended() Gets a boolean value determining whether the messages and invalidation mechanisms are suspended.
boolean	isTreeLoaded() Gets a value determining whether the node three of the parent chart is been loaded.
void	loadElementTree(ChartView view) Loads the element tree of the current ChartAreaModel with the corresponding ChartView.
void	onPanOffsetChanged() Called when the Chart's pan offset changes.
void	onZoomChanged() Called when the Chart's zoom factor changes.
void	previewMessage(ChartMessage message) Used by the MessageDispatcher to delegate messages to the ChartAreaModel.

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

enumDescendants, enumDescendants, enumDescendants, findAncestor, findDescendant, getPresenter, isAncestorOf, setPresenter

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

applyLayoutRounding, arrange, arrange, chartArea, clearValue, collectionIndex, getLayoutSlot, getNodeState, getParent, index, invalidate, 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

Constructor Detail

ChartAreaModel

public ChartAreaModel()

Creates an instance of the ChartAreaModel class by initializing its plot area and messaging infrastructure.

Method Detail

getView

public ChartView getView()

Gets the current chart view.

Returns:

the current chart view.

getPlotArea

public ChartPlotAreaModel getPlotArea()

Gets an instance of the ChartPlotAreaModel class representing the part of the chart where the data is plotted.

Returns:

the ChartPlotAreaModel instance.

getSeries

public ElementCollection<ChartSeriesModel> getSeries()

Gets a ElementCollection containing the currently available series in this ChartAreaModel.

Returns:

the series collection.

isTreeLoaded

public boolean isTreeLoaded()

Description copied from class: ChartNode

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

Overrides:

isTreeLoaded in class ChartNode

Returns:

true if the tree is loaded, otherwise false.

isSuspended

public boolean isSuspended()

Gets a boolean value determining whether the messages and invalidation mechanisms are suspended.

Returns:

true if the model is suspended, otherwise false.

getDispatcher

public MessageDispatcher getDispatcher()

Gets the MessageDispatcher instance associated with this ChartAreaModel.

Returns:

the MessageDispatcher instance.

onZoomChanged

public void onZoomChanged()

Called when the Chart's zoom factor changes.

onPanOffsetChanged

public void onPanOffsetChanged()

Called when the Chart's pan offset changes.

beginUpdate

public void beginUpdate()

Locks the ChartAreaModel for performing state update calls. When the model is locked, no messages or ChartNode updates are processed.

endUpdate

public void endUpdate(boolean refresh)

Unlocks the ChartAreaModel thus allowing the processing of ChartNode updates and messages.

Parameters:

refresh - if set to true forces the invalidation and refreshing of the model.

loadElementTree

public void loadElementTree(ChartView view)

Loads the element tree of the current ChartAreaModel with the corresponding ChartView.

Parameters:

view - the ChartView to load the tree with.

invalidateNode

public void invalidateNode(ChartNode node)

Invalidates the state of the specified ChartNode and refreshes it.

Parameters:

node - the ChartNode to invalidate and refresh.

canAddChild

public ModifyChildrenResult canAddChild(ChartNode child)

Description copied from class: ChartElement

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

Overrides:

canAddChild in class ChartElement

Parameters:

child - The child to be considered.

previewMessage

public void previewMessage(ChartMessage message)

Used by the MessageDispatcher to delegate messages to the ChartAreaModel.

Parameters:

message - the ChartMessage instance representing the message.

invalidate

public void invalidate(int flags)

Invalidates the ChartAreaModel by specifying what types of calculations will be performed after validation.

Parameters:

flags - a set of flas specifying the type of invalidation.

getNotLoadedReasons

public Iterable<String> getNotLoadedReasons()

Generates a collection of reasons describing why the chart could not be loaded.

Returns:

an Iterable implementation providing access to the not loaded reasons.