|
Style Intelligence v12.0 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectinetsoft.sree.HeadingTarget
public class HeadingTarget
Represents a heading in a Replet that is a target of a table of contents.
| 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 |
|---|
public static final int HEADING
public static final int TABLE
public static final int SECTION
public static final int GROUP
public static final int SEARCH_RESULT
| Constructor Detail |
|---|
public HeadingTarget(String path,
PageLocation location)
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.
public HeadingTarget(String path,
PageLocation location,
int type)
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.
public HeadingTarget(String path,
PageLocation location,
int type,
int baseRow)
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.
public HeadingTarget(String path,
PageLocation location,
int type,
int baseRow,
String elementID)
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.
public HeadingTarget(String path,
PageLocation location,
int type,
int baseRow,
int groupLevel,
String elementID,
Object[][] summaryValues)
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 |
|---|
public String getPath()
public void setPath(String path)
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 '#'.public PageLocation getLocation()
public void setLocation(PageLocation location)
location - the location of the targeted heading element.public int getType()
public void setType(int type)
type - one of the type constants defined in this class.public int getBaseRow()
public void setBaseRow(int baseRow)
baseRow - the table or section row.public int getGroupLevel()
public void setGroupLevel(int groupLevel)
groupLevel - the table or section group level.public String getElementID()
public void setElementID(String elementID)
elementID - the element ID.public Enumeration getSummaryValues()
public int hashCode()
hashCode in class Objectpublic boolean equals(Object obj)
equals in class Objectpublic int compareTo(Object obj)
compareTo in interface Comparableobj - the specified object.
|
Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved. | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||