com.telerik.widget.chart.engine.decorations.annotations.plotBand

Class CartesianPlotBandAnnotationModel

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.decorations.annotations.ChartAnnotationModel

com.telerik.widget.chart.engine.decorations.annotations.SingleAxisAnnotationModel

com.telerik.widget.chart.engine.decorations.annotations.plotBand.CartesianPlotBandAnnotationModel

public class CartesianPlotBandAnnotationModel
extends SingleAxisAnnotationModel

Represents a PlotBandAnnotationModel that displays an annotation in cartesian charts.

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
CartesianPlotBandAnnotationModel() Creates a new instance of the CartesianPlotBandAnnotationModel class.

Method Summary

Modifier and Type	Method and Description
Object	getFrom() Gets the object from which the band starts.
Object	getTo() Gets the object at which the band ends.
boolean	isUpdated() States whether the current annotation has been updated.
void	resetState() Used to reset the update state of the two plots.
void	setFrom(Object value) Sets the object from which the band starts.
void	setTo(Object value) Sets the object at which the band ends.

Methods inherited from class com.telerik.widget.chart.engine.decorations.annotations.SingleAxisAnnotationModel

getAxis, setAxis

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

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

Constructor Detail

CartesianPlotBandAnnotationModel

public CartesianPlotBandAnnotationModel()

Creates a new instance of the CartesianPlotBandAnnotationModel class.

Method Detail

getFrom

public Object getFrom()

Gets the object from which the band starts.

Returns:

the object from which the band starts.

setFrom

public void setFrom(Object value)

Sets the object from which the band starts.

Parameters:

value - the new starting object.

getTo

public Object getTo()

Gets the object at which the band ends.

Returns:

the ending band object.

setTo

public void setTo(Object value)

Sets the object at which the band ends.

Parameters:

value - the new object at which the band ends.

resetState

public void resetState()

Used to reset the update state of the two plots.

Specified by:

resetState in class ChartAnnotationModel

isUpdated

public boolean isUpdated()

Description copied from class: ChartAnnotationModel

States whether the current annotation has been updated.

Overrides:

isUpdated in class SingleAxisAnnotationModel

Returns:

true if the current annotation was updated and false otherwise.