com.sas.servlet.tbeans.graphics
Class BaseWaterfallChart

com.sas.servlet.tbeans.graphics.BaseWaterfallChart

All Implemented Interfaces:

ActionProviderViewInterface, HttpActionProviderInterface, HttpActionProviderViewInterface, com.sas.beans.PropertyChangeSource, com.sas.lang.ObjectDataInterface, com.sas.servlet.tbeans.features.FeatureListInterface, RenderableInterface, TransformationInterface, com.sas.util.WriteToPrintWriterInterface, java.io.Serializable

Direct Known Subclasses:

WaterfallChart

public abstract class BaseWaterfallChart

See Also:

Serialized Form

Constructor Summary

BaseWaterfallChart()

Method Summary

void	applyColorScheme(ColorScheme scheme) Apply a color scheme to this graph's display attributes.
void	applyGraphStyle(GraphStyle graphStyle) Apply the display properties in the GraphStyle to the WaterfallChart.
WaterfallChartModel	getGraphModel() Get the WaterfallChartModel that controls the WaterfallChart's display proeprties.
ChartImageMapInfo	getImageMapInfo() The WatefallChartImageMapInfo class encapsulates the mapping of regions associated with waterfall and line elements, labels (for both axes and legends) and values (for both axes and legends) as projected onto the display area along with their associated data.
void	setDataModel(WaterfallChartDataModel newDataModel) Setting a WaterfallChartDataModel supplies a handle to the data along with a description of how to interpret the data values (i.e. how the data values are to be calculated and where they are to be displayed).
void	setGraphModel(WaterfallChartModel newWaterfallChartModel) Set a WaterfallChartModel to control the WaterfallChart's display proeprties.

Methods inherited from class com.sas.servlet.tbeans.BaseActionTransformation

dispose, getActionProvider, getActionSupportType, getUniqueId, isActionVisible, listActionTypes, listAreaTypes, setActionProvider, setActionSupportType, setActionVisible, setUniqueId, write

Methods inherited from class com.sas.servlet.tbeans.BaseTransformation

addPropertyChangeListener, addPropertyChangeListener, cleanUpResources, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getCustomAttributes, getDescription, getId, getInputTransform, getLocale, getName, getObjectData, getObjectDataProperty, getOutputTransform, getRequest, getResponse, getTagEpilog, getTagProlog, hasListeners, isCleanUpResourcesOn, isVisible, removePropertyChangeListener, removePropertyChangeListener, setCleanUpResourcesOn, setCustomAttributes, setDescription, setId, setInputTransform, setLocale, setLocaleDependentProperties, setName, setObjectData, setObjectDataProperty, setOutputTransform, setRequest, setResponse, setTagEpilog, setTagProlog, setVisible, toString, write, write, write

Methods inherited from interface com.sas.actionprovider.HttpActionProviderViewInterface

getRequest, setRequest

Constructor Detail

BaseWaterfallChart

public BaseWaterfallChart()

Method Detail

setGraphModel

public void setGraphModel(WaterfallChartModel newWaterfallChartModel)
                   throws java.lang.IllegalArgumentException

Set a WaterfallChartModel to control the WaterfallChart's display proeprties. Modifying any WaterfallChartModel property will trigger the WaterfallChart to repaint. The update is asychrouns so modifying multiple properties in quick succession will result in only a single repaint. Use the FullPaintInterface if greater control over the WaterfallChart's paint behavior is necessary.

Parameters:

newWaterfallChartModel - the WaterfallChartModel that controls the WaterfallChart's display proeprties

Throws:

java.lang.IllegalArgumentException - if newWaterfallChartModel is null.

See Also:

getGraphModel(), WaterfallChartModel.apply(com.sas.graphics.components.waterfallchart.WaterfallChartModel)

getGraphModel

public WaterfallChartModel getGraphModel()

Get the WaterfallChartModel that controls the WaterfallChart's display proeprties.

Returns:

the WaterfallChartModel that controls the WaterfallChart's display proeprties

See Also:

getGraphModel(), WaterfallChartModel.apply(com.sas.graphics.components.waterfallchart.WaterfallChartModel)

setDataModel

public void setDataModel(WaterfallChartDataModel newDataModel)

Setting a WaterfallChartDataModel supplies a handle to the data along with a description of how to interpret the data values (i.e. how the data values are to be calculated and where they are to be displayed).

Any change in the WaterfallChartDataModel properties will cause the WaterfallChart to repaint. The update is asynchronous so modifying multiple properties in quick succession will result in only a single repaint. Use the FullPaintInterface to enforce greater control over the WaterfallChart's paint behavior.

Any data value changes detected will cause the WaterfallChart to repaint using the new values.

Non-valid WaterfallChartDataModel properties will be ignored. For instance: using a WaterfallChartTableDataModel where the RowVariable property is designting a data column that is not present in the TableModel (see the ScatterPlotTableDataModel's model property) would cause the RowVariable proeprty to be ignored.

The WaterfallChart requires that at a minimum there is some data applicable to its category axis. For instance: using a WaterfallChartTableDataModel would require that the CategoryVariable property identify a data column in the TableModel to generate a graph.

If the required information is not specified the WaterfallChart will attempt to automatically select some portion of the data to satify this requirement.

If however the required information is non-valid (i.e. supplied but not correct) then the WaterfallChart will not draw a graph. Automatically selecting data for non-valid settings would mask a problem in the WaterfallChart's usage.

A null WaterfallChartDataModel will cause the WaterfallChart to not draw a graph.

Parameters:

newDataModel - supplies a handle to the data along with a description of how to interpret the data values.

getImageMapInfo

public ChartImageMapInfo getImageMapInfo()

The WatefallChartImageMapInfo class encapsulates the mapping of regions associated with waterfall and line elements, labels (for both axes and legends) and values (for both axes and legends) as projected onto the display area along with their associated data.

Returns:

the mapping of regions associated with waterfall and line elements, labels (for both axes and legends) and values (for both axes and legends) as projected onto the display area along with their associated data.

applyColorScheme

public void applyColorScheme(ColorScheme scheme)

Apply a color scheme to this graph's display attributes.

Overrides:

applyColorScheme in class com.sas.servlet.tbeans.graphics.BaseGraph

Parameters:

scheme - class containing a set of colors for the charts.

applyGraphStyle

public void applyGraphStyle(GraphStyle graphStyle)

Apply the display properties in the GraphStyle to the WaterfallChart. The use of this method is a convenient way to quickly and easily affect the WaterfallChart's appearance is strongly encouraged.

Some GraphStyle properties like the background fill style will be applied to the WaterfallChart's WaterfallChartModel (thus affecting the WaterfallChartAppearance). Other GraphStyle properties like the title1 text style will be applied to properties on other WaterfallChart models such as the WaterfallChart's title1 NoteModel in this example.

The GraphStyle enforces certain constraints that are not enforced on a Graph. For example the WaterfallChart supports setting different axis value text styles on different axes (via the WaterfallChartModel's category and response AxisModels) whereas a GraphStyle only supports a single axis value text style property. When a GraphStyle is applied to a WaterfallChart all of the WaterfallChart's axes values use the GraphStyle axis value setting (thus easily enforcing that all axes values are represented in the same font and color). The use of the GraphStyle allows for easier graph customizations while the WaterfallChart models allow for greated customizations when desired.

Modifying any of the properties in the GraphStyle after this call will have no affect on the WaterfallChart. Likewise modifying any WaterfallChart properties after this call will have no affect on the GraphStyle. This method simply conveys the properties in the GraphStyle onto the WaterfallChart properties.

A blind PropertyChangeEvent will be fired by the WaterfallChart after the apply is made.

No action will be taken if a null GraphStyle is passed in.

Overrides:

applyGraphStyle in class com.sas.servlet.tbeans.graphics.BaseGraph

Parameters:

graphStyle - the GraphStyle whose properties are conveyed to the WaterfallChart