Style Intelligence v12.0

inetsoft.graph.aesthetic
Class VisualFrame

java.lang.Object
  extended by inetsoft.graph.aesthetic.VisualFrame
All Implemented Interfaces:
Serializable, Cloneable
Direct Known Subclasses:
ColorFrame, LineFrame, ShapeFrame, SizeFrame, TextFrame, TextureFrame

public abstract class VisualFrame
extends Object
implements Cloneable, Serializable

This class defines the common API for all aesthetic frames.

See Also:
Serialized Form

Constructor Summary
VisualFrame()
          Constructor.
 
Method Summary
 Object clone()
          Create a copy of this object.
static Comparator createComparator()
          Create comparator to sort legend frames.
 boolean equals(Object obj)
          Check if equals another object.
 String getField()
          Get the column associated with this frame.
 Object[] getLabels()
          Get the labels of the values to show on the legend.
 VisualFrame getLegendFrame()
          Get the frame that is used to display the legend for this frame.
 LegendSpec getLegendSpec()
          Get the legend specification.
 Scale getScale()
          Get the scale for mapping the value from a dataset to the frame.
 int getScaleOption()
          Get the scale initialization option, e.g.
 String getTitle()
          Get the title to show on the legend.
 Object[] getValues()
          Get the values mapped by this frame.
 int hashCode()
          Get the hashcode of the frame.
 void init(DataSet data)
          Initialize the legend frame with values from the dataset.
 boolean isValid()
          Check if this frame has been initialized and is ready to be used.
 boolean isVisible()
          Check if the frame should be shown as a legend.
 void setField(String field)
          Set the column associated with this frame.
 void setLegendFrame(VisualFrame frame)
          Set the frame that is used for displaying the legend for this frame in the case that this frame is merged with the legend frame.
 void setLegendSpec(LegendSpec legendSpec)
          Set the legend attributes.
 void setScale(Scale scale)
          Set the scale for mapping the value from a dataset to the frame.
 void setScaleOption(int option)
          Set the scale initialization option, e.g.
 String toString()
           
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

VisualFrame

public VisualFrame()
Constructor.

Method Detail

getTitle

public String getTitle()
Get the title to show on the legend.


getValues

public Object[] getValues()
Get the values mapped by this frame.


setField

public void setField(String field)
Set the column associated with this frame.


getField

public String getField()
Get the column associated with this frame.


setScale

public void setScale(Scale scale)
Set the scale for mapping the value from a dataset to the frame.


getScale

public Scale getScale()
Get the scale for mapping the value from a dataset to the frame.


init

public void init(DataSet data)
Initialize the legend frame with values from the dataset.


getLegendSpec

public LegendSpec getLegendSpec()
Get the legend specification.


setLegendSpec

public void setLegendSpec(LegendSpec legendSpec)
Set the legend attributes.


getScaleOption

public int getScaleOption()
Get the scale initialization option, e.g. Scale.TICKS | Scale.ZERO.


setScaleOption

public void setScaleOption(int option)
Set the scale initialization option, e.g. Scale.TICKS | Scale.ZERO.


getLabels

public Object[] getLabels()
Get the labels of the values to show on the legend. The default implementation will just convert values to labels.


isVisible

public boolean isVisible()
Check if the frame should be shown as a legend. The default implementation will just check whether there are multiple labels.


isValid

public boolean isValid()
Check if this frame has been initialized and is ready to be used.


setLegendFrame

public void setLegendFrame(VisualFrame frame)
Set the frame that is used for displaying the legend for this frame in the case that this frame is merged with the legend frame.


getLegendFrame

public VisualFrame getLegendFrame()
Get the frame that is used to display the legend for this frame.


equals

public boolean equals(Object obj)
Check if equals another object. The default implementation will just test whether class is equal.

Overrides:
equals in class Object

hashCode

public int hashCode()
Get the hashcode of the frame.

Overrides:
hashCode in class Object

clone

public Object clone()
Create a copy of this object.

Overrides:
clone in class Object

createComparator

public static Comparator createComparator()
Create comparator to sort legend frames.


toString

public String toString()
Overrides:
toString in class Object

Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.