Style Intelligence v12.0

inetsoft.graph.aesthetic
Class StackTextFrame

java.lang.Object
  extended by inetsoft.graph.aesthetic.VisualFrame
      extended by inetsoft.graph.aesthetic.TextFrame
          extended by inetsoft.graph.aesthetic.StackTextFrame
All Implemented Interfaces:
CategoricalFrame, Serializable, Cloneable

public class StackTextFrame
extends TextFrame
implements CategoricalFrame

This class returns a value for each stack instead of every data point.

See Also:
Serialized Form

Constructor Summary
StackTextFrame()
          Create a text frame.
StackTextFrame(GraphElement elem, String var)
          Create a text frame.
 
Method Summary
 boolean equals(Object obj)
          Check if equals another object.
 String[] getDimensions()
          Get the dimensions to group data.
 int[] getStackRowIndexes(int index)
          Get the stack row indexes if stackmap contains index.
 Object getText(DataSet data, String col, int row)
          Get the text for the specified cell.
 void init(DataSet data)
          Initialize the legend frame with values from the dataset.
 boolean isStackNegative()
          Check if negative values are stacked separately.
 boolean isStatic(Object val)
          Check if the value is assigned a static aesthetic value.
 boolean isValid()
          Check if this frame has been initialized and is ready to be used.
 void setDimensions(String[] dims)
          Set the dimensions to group data.
 void setStackNegative(boolean negGrp)
          Set whether negative values are stacked separately.
 
Methods inherited from class inetsoft.graph.aesthetic.TextFrame
getKeys, getText, getTitle, getValues, getVisibleField, getVisibleRange, getVisibleValues, isTextVisible, isVisible, setVisibleField, setVisibleRange, setVisibleValues
 
Methods inherited from class inetsoft.graph.aesthetic.VisualFrame
clone, createComparator, getField, getLabels, getLegendFrame, getLegendSpec, getScale, getScaleOption, hashCode, setField, setLegendFrame, setLegendSpec, setScale, setScaleOption, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

StackTextFrame

public StackTextFrame()
Create a text frame. The field needs to be set by calling setField.


StackTextFrame

public StackTextFrame(GraphElement elem,
                      String var)
Create a text frame.

Parameters:
elem - the corresponding element to extract dimensions.
var - the field for calculating stack value.
Method Detail

setDimensions

public void setDimensions(String[] dims)
Set the dimensions to group data.


getDimensions

public String[] getDimensions()
Get the dimensions to group data.


isStackNegative

public boolean isStackNegative()
Check if negative values are stacked separately.


setStackNegative

public void setStackNegative(boolean negGrp)
Set whether negative values are stacked separately. If true (default), the negative values are stacked downward and positive values are stacked upward. Otherwise, all values are accumulated together.


isValid

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

Overrides:
isValid in class VisualFrame

init

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

Overrides:
init in class VisualFrame

getText

public Object getText(DataSet data,
                      String col,
                      int row)
Get the text for the specified cell.

Overrides:
getText in class TextFrame
Parameters:
data - the specified dataset.
col - the specified column name.
row - the specified row index.

getStackRowIndexes

public int[] getStackRowIndexes(int index)
Get the stack row indexes if stackmap contains index.

Parameters:
row - index.
Returns:
the row indexes of the same key.

equals

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

Overrides:
equals in class TextFrame

isStatic

public boolean isStatic(Object val)
Check if the value is assigned a static aesthetic value.

Specified by:
isStatic in interface CategoricalFrame

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