Style Intelligence v12.0

inetsoft.graph.aesthetic
Class TextFrame

java.lang.Object
  extended by inetsoft.graph.aesthetic.VisualFrame
      extended by inetsoft.graph.aesthetic.TextFrame
All Implemented Interfaces:
Serializable, Cloneable
Direct Known Subclasses:
DefaultTextFrame, MultiTextFrame, StackTextFrame

public abstract class TextFrame
extends VisualFrame

This class defines the common API for all text frames.

See Also:
Serialized Form

Constructor Summary
TextFrame()
           
 
Method Summary
 boolean equals(Object obj)
          Check if equals another object.
 Collection getKeys()
          Get the aliased values.
 Object getText(DataSet data, String col, int row)
          Get the text for the specified cell.
 Object getText(Object val)
          Get the text for the specified value.
 String getTitle()
          Get the title to show on the legend.
 Object[] getValues()
          Get the values of the mapped by this frame.
 String getVisibleField()
          Get the column to compare against visible values.
 Comparable[] getVisibleRange()
          Get the visible range as [lower, upper].
 Object[] getVisibleValues()
          Get the values to show text label.
protected  boolean isTextVisible(DataSet data, int row)
          Check if value matches visible values.
 boolean isVisible()
          Check if the legend frame should be shown as a legend.
 void setVisibleField(String vfield)
          Set the column to compare against visible values.
 void setVisibleRange(Comparable lo, Comparable hi)
          Set the range of value to show label.
 void setVisibleValues(Object[] vals)
          Set the values to show label.
 
Methods inherited from class inetsoft.graph.aesthetic.VisualFrame
clone, createComparator, getField, getLabels, getLegendFrame, getLegendSpec, getScale, getScaleOption, hashCode, init, isValid, setField, setLegendFrame, setLegendSpec, setScale, setScaleOption, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TextFrame

public TextFrame()
Method Detail

isVisible

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

Overrides:
isVisible in class VisualFrame

getValues

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

Overrides:
getValues in class VisualFrame

getTitle

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

Overrides:
getTitle in class VisualFrame

getKeys

public Collection getKeys()
Get the aliased values.


getText

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

Parameters:
data - the specified dataset.
col - the specified column name.
row - the specified row index.

getText

public Object getText(Object val)
Get the text for the specified value.


setVisibleField

public void setVisibleField(String vfield)
Set the column to compare against visible values. The setVisibleValues or setVisibleRange must be called to set the visibility condition.


getVisibleField

public String getVisibleField()
Get the column to compare against visible values.


setVisibleValues

public void setVisibleValues(Object[] vals)
Set the values to show label. The values are compared against the values from the column specified by setVisibleField. If the value matches, the label is shown, otherwise the label is ignored.


getVisibleValues

public Object[] getVisibleValues()
Get the values to show text label.

See Also:
setVisibleValues;

setVisibleRange

public void setVisibleRange(Comparable lo,
                            Comparable hi)
Set the range of value to show label. The range is compared against the values from the column specified by setVisibleField. If the value is in the range (inclusive), the label is shown, otherwise the label is ignored.

Parameters:
lo - date or number, the lower bound of the range, or null to ignore.
hi - date or number, the upper bound of the range, or null to ignore.

getVisibleRange

public Comparable[] getVisibleRange()
Get the visible range as [lower, upper].


isTextVisible

protected boolean isTextVisible(DataSet data,
                                int row)
Check if value matches visible values.


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 VisualFrame

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