com.sas.servlet.tbeans.graphics
Class BaseBarLineChart

com.sas.servlet.tbeans.graphics.BaseBarLineChart

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:

BarLineChart

public class BaseBarLineChart

The BarLineChart is a Swing component that uses a BarLineChartDataModel (data properties) and a BarLineChartModel (display properties) to produce a series of connected veticies representing data values.

Data

The number and arrangement of data elements (i.e. bars and lines), axes and legend is determined by the BarLineChartDataModel (assigned via the setDataModel method) which provides a handle to data and associated mapping properties. To illustrate the BarLineChartTableDataModel is used to assign a Swing TableModel along with a collection of variable properties to define the data column mapping onto the graph. The BarLineChartOLAPDataModel is used to assign OLAP data via a com.sas.storage.olap.OLAPDataSetInterface.

Display Properties

The BarLineChartModel properties define the display appearance. The BarLineChartModel contains BarLineChart specific properties, common graph properties and a collection of contained models (which provide display properties for sub-portions of the graph such as the legend). The BarLineChart guarantees a non-null BarLineChartModel via the getGraphModel method. Passing a null parameter to the BarLineChart's setGraphModel method triggers an IllegalArgumentException. The BarLineChartModel properties can be modified directly.

For example:

 BarLineChart barLineChart = new BarLineChart();
 BarLineChartModel barLineChartModel = barLineChart.getGraphModel();

 // Assign background color
 barLineChartModel.setBackgroundFillStyle(new FillStyle(Color.lightGray));

 // Assign data element outline color
 barLineChartModel.getDataElementStyles().getOutlineLineStyle().setColor(Color.yellow);
 

However it may be simpler to modify the properties indirectly by applying a GraphStyle via the applyGraphStyle method. The BarLineChartModel allows for a high degree of control over the BarLineChart's appearance. Because of the large number of display properties and the repetitive nature of some of the properties (for example: there are text style properties for the values text in the legend, response axis, category axis and data element values) applying a GraphStyle on the BarLineChart may be the simplest way to obtain the desired results. A GraphStyle is a collection of graph properties that can be applied to any graph. Several predefined GraphStyles are provided and can be used as is or tweaked to provide the desired presentation. Applying a GraphStyle on a BarLineChart will modify some of the BarLineChartModel properties.

See Also:

Graph, GraphStyle, NoteModel, BarLineChartModel, BarLineChartDataModel, BarLineChartTableDataModel, BarLineChartOLAPDataModel, Serialized Form

Constructor Summary

BaseBarLineChart()
Construct a BarLineChart using the default GraphStyle (GraphStyle.CONVENTION_STYLE).

Method Summary

void	applyColorScheme(ColorScheme scheme) Apply a color scheme to this graph's display attributes.
void	applyGraphStyle(GraphStyle graphStyle) Apply the GraphStyle display properties onto the BarLineChart.
BarLineChartModel	getGraphModel() Returns the BarLineChartModel that encapsulates most of the BarLineChart's display properties.
ChartImageMapInfo	getImageMapInfo() The BarLineChartImageMapInfo class encapsulates the mapping of regions associated with 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(BarLineChartDataModel newDataModel) Sets the BarLineChartDataModel that provides data properties like where the data values are located and how they are to be displayed by the BarLineChart.
void	setGraphModel(BarLineChartModel newBarLineChartModel) Sets a BarLineChartModel to define most of the BarLineChart's display properties.

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

BaseBarLineChart

public BaseBarLineChart()

Construct a BarLineChart using the default GraphStyle (GraphStyle.CONVENTION_STYLE).

See Also:

GraphStyle

Method Detail

setGraphModel

public void setGraphModel(BarLineChartModel newBarLineChartModel)
                   throws java.lang.IllegalArgumentException

Sets a BarLineChartModel to define most of the BarLineChart's display properties. Modifying any BarLineChartModel property triggers the BarLineChart to update. The update is asynchronous and delayed so modifying multiple properties in quick succession will result in only a single update. Use the FullPaintInterface if greater control over the BarLineChart's paint behavior is necessary.

Typically applyGraphStyle is used to modify the graphs display properties.

Parameters:

newBarLineChartModel - the BarLineChartModel that encapsulates the BarLineChart's display properties

Throws:

java.lang.IllegalArgumentException - if newBarLineChartModel is null.

See Also:

getGraphModel(), BarLineChartModel.apply(com.sas.graphics.components.barlinechart.BarLineChartModel), GraphStyle

getGraphModel

public BarLineChartModel getGraphModel()

Returns the BarLineChartModel that encapsulates most of the BarLineChart's display properties.

Returns:

the BarLineChartModel that encapsulates most of the BarLineChart's display properties

See Also:

setGraphModel(com.sas.graphics.components.barlinechart.BarLineChartModel), BarLineChartModel.apply(com.sas.graphics.components.barlinechart.BarLineChartModel)

setDataModel

public void setDataModel(BarLineChartDataModel newDataModel)

Sets the BarLineChartDataModel that provides data properties like where the data values are located and how they are to be displayed by the BarLineChart.

Any change in the BarLineChartDataModel properties will cause the BarLineChart to update. The update is asynchronous and delayed so modifying multiple properties in quick succession will result in only a single update. The FullPaintInterface can be used if greater control over the BarLineChart's paint behavior is needed.

Note: Data value changes will also trigger BarLineChart to update.

A valid BarLineChartDataModel is required to draw a graph.

Parameters:

newDataModel - provides a handle to the data along with any associated mapping properties

See Also:

BarLineChartTableDataModel, BarLineChartOLAPDataModel

getImageMapInfo

public ChartImageMapInfo getImageMapInfo()

The BarLineChartImageMapInfo class encapsulates the mapping of regions associated with 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. This is particularly useful with creating html imagemap information if the graph is used to create an image for an html document.

Returns:

the mapping of regions associated with graph elements

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 GraphStyle display properties onto the BarLineChart. The use of this method is a convenient way to quickly and easily affect the BarLineChart's appearance. The BarLineChartModel (accessible via the getGraphModel method) properties and the NoteModels (accessible via the getTitle and getFootnote methods) properties are modified by this method.

The GraphStyle enforces certain constraints that are not enforced on the Graph's display models (BarLineChartModel and NoteModels). For example only one value text color may be specified on the GraphStyle, whereas the BarLineChartModel supports setting different value text colors between axes, legends and data element text. Most presentations only require a single color for all types of value text, which is easily achieved by applying a GraphStyle.

Applying a GraphStyle will modify the display properties of the BarLineChartModel and the title and footnote NoteModels. The BarLineChart does not retain a link to the GraphStyle after this method has been called. Modifying any of the GraphStyle properties after this method has been called will have no affect on the BarLineChart. Similarly modifying any of BarLineChart's display properties after this method has been called will have no affect on the GraphStyle properties. To affect any change in the BarLineChart display appearance the modified GraphStyle or a different GraphStyle would need to be applied again.

A blind PropertyChangeEvent is fired by the BarLineChart after the apply is made.

No action is 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 BarLineChart

See Also:

NoteModel, BarLineChartModel