com.ge.research.acuity.ui
Class Graph3D

java.lang.Object
  com.ge.research.acuity.ui.PresentationObject
      com.ge.research.acuity.ui.IndependentDisplayPO
          com.ge.research.acuity.ui.GraphPO
              com.ge.research.acuity.ui.Graph3D

public class Graph3D

extends GraphPO

Extension to the GraphPO class, specific for 3D graphs

Version:

$Revision: 1.1 $ $Date: 2006/08/11 00:17:24 $

Author:

garbiras

Constructor Summary

Graph3D()
Calls the default constructor with null argument

Graph3D(java.lang.String title)
The default constructor.

Method Summary

void	addZLabel(double zValue, java.lang.String label) Adds a label to the Map of z axis values to display labels for the z axis point zValue
java.lang.String	getZAxisTitle() Returns the label to be used as the title of the z axis on the graph
java.util.Map	getZLabels() Returns the map of z axis point values to the labels that should be used when displaying the z axis in a graph
void	removeZLabel(double zValue) Removes the z axis point value to label relationship in the zLabels map for the z axis point value zValue
void	removeZLabels() Removes all the z axis point value to label relationships
void	setZAxisTitle(java.lang.String title) Sets the title of the z axis
void	setZLabels(java.util.Map map) Sets the map relating z axis point values to the labels that should be used when displaying the z axis in a graph

Methods inherited from class com.ge.research.acuity.ui.GraphPO

addDataseries, addXLabel, addYLabel, displayXGridlines, displayYGridlines, getDataseries, getDataseries, getMaxXValue, getMaxYValue, getMinXValue, getMinYValue, getOpacity, getTitle, getXAxisTitle, getXLabels, getYAxisTitle, getYLabels, refreshHighlightRegions, removeDataseries, removeDataseries, removeDataseries, removeXLabel, removeXLabels, removeYLabel, removeYLabels, reorderDataseries, setDisplayXGridlines, setDisplayYGridlines, setHasPresentationNature, setOpacity, setTitle, setXAxisTitle, setXLabels, setYAxisTitle, setYLabels

Methods inherited from class com.ge.research.acuity.ui.IndependentDisplayPO

canBeRemoved, displayBanner, getHeight, getIdentifierTitle, getWidth, getXPos, getYPos, getZOrder, setCanBeRemoved, setDisplayBanner, setHeight, setIdentifier, setIdentifierTitle, setPos, setPos, setPos, setPos, setWidth, setXPos, setYPos, setZOrder

Methods inherited from class com.ge.research.acuity.ui.PresentationObject

addLookupInfo, getHasPresentationNature, getIdentifier, getLookupInfo, getSubject, hasSubject, isDisplayed, isEditable, setEditability, setIsDisplayed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Graph3D

public Graph3D()

Calls the default constructor with null argument

Graph3D

public Graph3D(java.lang.String title)

The default constructor. Calls super(title), setting the graph title. Sets the presentation nature to PresentationNatureConstants.GRAPH3D

Parameters:

title - the graph title

See Also:

GraphPO.GraphPO(java.lang.String), PresentationObject.setHasPresentationNature(java.lang.String)

Method Detail

addZLabel

public void addZLabel(double zValue,
                      java.lang.String label)

Adds a label to the Map of z axis values to display labels for the z axis point zValue

Parameters:

zValue - the value of the z axis to add a label for

label - the label to display on the z axis at the point zValue

getZAxisTitle

public java.lang.String getZAxisTitle()

Returns the label to be used as the title of the z axis on the graph

Returns:

The label for the z axis

getZLabels

public java.util.Map getZLabels()

Returns the map of z axis point values to the labels that should be used when displaying the z axis in a graph

Returns:

the map of z axis point values to their display labels

removeZLabel

public void removeZLabel(double zValue)

Removes the z axis point value to label relationship in the zLabels map for the z axis point value zValue

Parameters:

zValue - the z axis value for which to remove label information about from the zLabel map

removeZLabels

public void removeZLabels()

Removes all the z axis point value to label relationships

setZAxisTitle

public void setZAxisTitle(java.lang.String title)

Sets the title of the z axis

Parameters:

title - the new label for the z axis title

setZLabels

public void setZLabels(java.util.Map map)

Sets the map relating z axis point values to the labels that should be used when displaying the z axis in a graph

Parameters:

map - the map of z axis point values to their display labels