Style Intelligence v12.0

inetsoft.sree
Class HeadingTarget

java.lang.Object
  extended by inetsoft.sree.HeadingTarget
All Implemented Interfaces:
Serializable, Comparable

public class HeadingTarget
extends Object
implements Serializable, Comparable

Represents a heading in a Replet that is a target of a table of contents.

Since:
version 5.0
See Also:
Serialized Form

Field Summary
static int GROUP
          Constant that indicates that a heading target points to a group row in a section or table.
static int HEADING
          Constant that indicates a heading target points to a heading element.
static int SEARCH_RESULT
          Constant that indicates a heading target points to a search result.
static int SECTION
          Constant that indicates a heading target points to a section element.
static int TABLE
          Constant that indicates a heading target points to a table element.
 
Constructor Summary
HeadingTarget(String path, PageLocation location)
          Create a new instance of HeadingTarget.
HeadingTarget(String path, PageLocation location, int type)
          Create a new instance of HeadingTarget.
HeadingTarget(String path, PageLocation location, int type, int baseRow)
          Create a new instance of HeadingTarget.
HeadingTarget(String path, PageLocation location, int type, int baseRow, int groupLevel, String elementID, Object[][] summaryValues)
          Create a new instance of HeadingTarget.
HeadingTarget(String path, PageLocation location, int type, int baseRow, String elementID)
          Create a new instance of HeadingTarget.
 
Method Summary
 int compareTo(Object obj)
          Compare to another object.
 boolean equals(Object obj)
           
 int getBaseRow()
          Gets the row in the table or section to which this target points.
 String getElementID()
          Gets the element ID of the element to which this target is pointing.
 int getGroupLevel()
          Gets the group level in the table or section to which this target points.
 PageLocation getLocation()
          Get the location of the targeted heading element.
 String getPath()
          Get the path to the targeted heading element.
 Enumeration getSummaryValues()
          Gets the summary values for the group to which this target is pointing.
 int getType()
          Gets the type of element pointed to by this target.
 int hashCode()
           
 void setBaseRow(int baseRow)
          Sets the row in the table or section to which this target points.
 void setElementID(String elementID)
          Sets the element ID of the element to which this target is pointing.
 void setGroupLevel(int groupLevel)
          Sets the group level in the table or section to which this target points.
 void setLocation(PageLocation location)
          Set the location of the targeted heading element.
 void setPath(String path)
          Set the path to the targeted heading element.
 void setType(int type)
          Sets the type of element pointed to by this target.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

HEADING

public static final int HEADING
Constant that indicates a heading target points to a heading element.

See Also:
Constant Field Values

TABLE

public static final int TABLE
Constant that indicates a heading target points to a table element.

See Also:
Constant Field Values

SECTION

public static final int SECTION
Constant that indicates a heading target points to a section element.

See Also:
Constant Field Values

GROUP

public static final int GROUP
Constant that indicates that a heading target points to a group row in a section or table.

See Also:
Constant Field Values

SEARCH_RESULT

public static final int SEARCH_RESULT
Constant that indicates a heading target points to a search result.

See Also:
Constant Field Values
Constructor Detail

HeadingTarget

public HeadingTarget(String path,
                     PageLocation location)
Create a new instance of HeadingTarget.

Parameters:
path - a concatenation of heading elements from the top level to the level of the targeted heading element, separated by '/'. Internal targets (hyperlink anchors) start with a '#'.
location - the location of the targeted heading element.

HeadingTarget

public HeadingTarget(String path,
                     PageLocation location,
                     int type)
Create a new instance of HeadingTarget.

Parameters:
path - a concatenation of heading elements from the top level to the level of the targeted heading element, separated by '/'. Internal targets (hyperlink anchors) start with a '#'.
location - the location of the targeted heading element.
type - the type of element pointed to by the target.

HeadingTarget

public HeadingTarget(String path,
                     PageLocation location,
                     int type,
                     int baseRow)
Create a new instance of HeadingTarget.

Parameters:
path - a concatenation of heading elements from the top level to the level of the targeted heading element, separated by '/'. Internal targets (hyperlink anchors) start with a '#'.
location - the location of the targeted heading element.
type - the type of element pointed to by the target.
baseRow - the row in the table or section to which the target points.

HeadingTarget

public HeadingTarget(String path,
                     PageLocation location,
                     int type,
                     int baseRow,
                     String elementID)
Create a new instance of HeadingTarget.

Parameters:
path - a concatenation of heading elements from the top level to the level of the targeted heading element, separated by '/'. Internal targets (hyperlink anchors) start with a '#'.
location - the location of the targeted heading element.
type - the type of element pointed to by the target.
baseRow - the row in the table or section to which the target points.
elementID - the element ID of the element to which the target points.

HeadingTarget

public HeadingTarget(String path,
                     PageLocation location,
                     int type,
                     int baseRow,
                     int groupLevel,
                     String elementID,
                     Object[][] summaryValues)
Create a new instance of HeadingTarget.

Parameters:
path - a concatenation of heading elements from the top level to the level of the targeted heading element, separated by '/'. Internal targets (hyperlink anchors) start with a '#'.
location - the location of the targeted heading element.
type - the type of element pointed to by the target.
baseRow - the row in the table or section to which the target points.
groupLevel - the group level in the table or section to which the target points.
elementID - the element ID of the element to which the target points.
summaryValues - the values of the summary columns for the group to which the target points.
Method Detail

getPath

public String getPath()
Get the path to the targeted heading element.

Returns:
a concatenation of heading elements from the top level to the level of the targeted heading element, separated by '/'. Internal targets (hyperlink anchors) start with a '#'.

setPath

public void setPath(String path)
Set the path to the targeted heading element.

Parameters:
path - a concatenation of heading elements from the top level to the level of the targeted heading element, separated by '/'. Internal targets (hyperlink anchors) start with a '#'.

getLocation

public PageLocation getLocation()
Get the location of the targeted heading element.

Returns:
the location of the targeted heading element.

setLocation

public void setLocation(PageLocation location)
Set the location of the targeted heading element.

Parameters:
location - the location of the targeted heading element.

getType

public int getType()
Gets the type of element pointed to by this target.

Returns:
one of the type constants defined in this class.

setType

public void setType(int type)
Sets the type of element pointed to by this target.

Parameters:
type - one of the type constants defined in this class.

getBaseRow

public int getBaseRow()
Gets the row in the table or section to which this target points.

Returns:
the table or section row.

setBaseRow

public void setBaseRow(int baseRow)
Sets the row in the table or section to which this target points.

Parameters:
baseRow - the table or section row.

getGroupLevel

public int getGroupLevel()
Gets the group level in the table or section to which this target points.

Returns:
the table or section group level.

setGroupLevel

public void setGroupLevel(int groupLevel)
Sets the group level in the table or section to which this target points.

Parameters:
groupLevel - the table or section group level.

getElementID

public String getElementID()
Gets the element ID of the element to which this target is pointing.

Returns:
the element ID.

setElementID

public void setElementID(String elementID)
Sets the element ID of the element to which this target is pointing.

Parameters:
elementID - the element ID.

getSummaryValues

public Enumeration getSummaryValues()
Gets the summary values for the group to which this target is pointing.

Returns:
an Enumeration of two-element Object arrays. The arrays contain the column name and value of a summary column.

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

compareTo

public int compareTo(Object obj)
Compare to another object.

Specified by:
compareTo in interface Comparable
Parameters:
obj - the specified object.
Returns:
compare result.

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