JClass DesktopViews 6.3.0 API
Documentation

com.klg.jclass.chart3d
Class JCData3dIndex

java.lang.Object
  |
  +--com.klg.jclass.chart3d.JCData3dIndex
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
JCData3dContourIndex, JCData3dGridIndex, JCData3dLabelIndex, JCData3dPointIndex

public class JCData3dIndex
extends Object
implements Serializable

JCData3dIndex contains a unique index to a data point in Chart3d consisting of either a (x, y) grid data value or (series, point) point data value. It is used by the chart3d's pick() and unpick() methods, and also contains information related to these operations.

See Also:
Serialized Form

Field Summary
static int ALL
          Special index value that implies using all indices.
protected  com.klg.jclass.chart3d.Chart3dDataView dataView
          Data view object for the data point that this index references.
protected  double distance
          The distance of a selected point from its closest grid point.
protected  Object obj
          Chart3d object picked (legend, chart3dArea).
protected  com.klg.jclass.chart3d.JCGridColor parent
          If this is a child of a grid color, use this to propagate changes.
 
Constructor Summary
JCData3dIndex()
          Simple constructor for JCData3dIndex.
JCData3dIndex(com.klg.jclass.chart3d.Chart3dDataView dataView)
          Constructor that creates a data index from a dataView and data.
 
Method Summary
 com.klg.jclass.chart3d.Chart3dDataView getDataView()
          Gets the value of the DataView property.
 double getDistance()
          Gets the value of the Distance property.
 Object getObject()
          Gets the value of the Obj property.
protected  void setChanged(boolean b, int cf)
          Telld the parent (if there is one) that a change has happened.
 void setDataView(com.klg.jclass.chart3d.Chart3dDataView dataView)
          Sets the value of the DataView property.
 void setDistance(double distance)
          Sets the value of the Distance property.
 void setObject(Object object)
          Sets the value of the Obj property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ALL

public static final int ALL
Special index value that implies using all indices.

See Also:
Constant Field Values

obj

protected Object obj
Chart3d object picked (legend, chart3dArea).


dataView

protected com.klg.jclass.chart3d.Chart3dDataView dataView
Data view object for the data point that this index references.


parent

protected com.klg.jclass.chart3d.JCGridColor parent
If this is a child of a grid color, use this to propagate changes.


distance

protected double distance
The distance of a selected point from its closest grid point.

Constructor Detail

JCData3dIndex

public JCData3dIndex()
Simple constructor for JCData3dIndex.


JCData3dIndex

public JCData3dIndex(com.klg.jclass.chart3d.Chart3dDataView dataView)
Constructor that creates a data index from a dataView and data.

Parameters:
dataView - the dataView this index is based upon
Method Detail

getDataView

public com.klg.jclass.chart3d.Chart3dDataView getDataView()
Gets the value of the DataView property. It contains the Chart3dDataView instance that holds the point that this data index class is referring to.

Returns:
the data view

setDataView

public void setDataView(com.klg.jclass.chart3d.Chart3dDataView dataView)
Sets the value of the DataView property. It contains the ChartDataView instance that holds the point that this data index class is referring to.

Parameters:
dataView - sets a new data view for this object

getObject

public Object getObject()
Gets the value of the Obj property. It is used by pick operations and contains the object picked (for example, a JCChart3dArea or JCLegend instance) by those operations.

Returns:
picked object

setObject

public void setObject(Object object)
Sets the value of the Obj property. It is used by pick operations and contains the object picked (for example, a JCChart3dArea or JCLegend instance) by those operations.

Parameters:
object - picked object

getDistance

public double getDistance()
Gets the value of the Distance property. It is used by pick operations and contains the distance between the point selected and the nearest data point.

Returns:
distance from the selected point

setDistance

public void setDistance(double distance)
Sets the value of the Distance property. It is used by pick operations and contains the distance between the point selected and the nearest data point.

Parameters:
distance - the new distance from the data point

setChanged

protected void setChanged(boolean b,
                          int cf)
Telld the parent (if there is one) that a change has happened.

Parameters:
b - has a changed happened
cf - mask which tells what type of change has happened

Copyright © 2004 Quest Software Inc..
All rights reserved.