Style Intelligence v12.0

inetsoft.sree
Class PageLocation

java.lang.Object
  extended by inetsoft.sree.PageLocation
All Implemented Interfaces:
Serializable, Cloneable

public class PageLocation
extends Object
implements Serializable, Cloneable

This class describes the location on a report, including page index, the paintable on the page, and the row/column on the paintable if applicable.

See Also:
Serialized Form

Field Summary
static int BODY
          Element is in report body.
static int FOOTER
          Element is in report footer.
static int HEADER
          Element is in report header.
 
Constructor Summary
PageLocation()
          New location at top of first page.
PageLocation(int page)
          Page location at the top of the page.
PageLocation(int page, int paintable)
          Page location at the specified element item.
PageLocation(int page, int paintable, int row, int region, int y)
          Page location at the specified element item.
 
Method Summary
 Object clone()
           
 String getDescription()
          Get the description of the PageLocation.
 int getPageIndex()
          Get the page index, starts from 0.
 int getPageRegion()
          Return the region of the page this PageLocation exists.
 int getPaintableIndex()
          Get the element paintable index.
 int getRow()
          Get the row number in table.
 String getURLString()
          Get the url String represents the PageLocation.
 int getY()
          Get the Y position on the page.
 boolean isInSection()
          Determines if this page location is in a section.
 boolean isInTable()
          Determines if this page location is in a table.
static PageLocation parseURLString(String str)
          Parse the url String represents a PageLocation to the represented PageLocation.
 void setDescription(String description)
          Set the description of the PageLocation.
 void setInSection(boolean inSection)
          Sets whether this page location is in a section.
 void setInTable(boolean inTable)
          Sets whether this page location is in a table.
 void setPageIndex(int page)
          Set the page index.
 void setPageRegion(int region)
          Set the region of the page this PageLocation exists.
 void setPaintableIndex(int paintable)
          Set the element paintable index.
 void setRow(int row)
          Set the table row number.
 void setY(int y)
          Set the Y position on the page.
 String toString()
           
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

BODY

public static final int BODY
Element is in report body.

See Also:
Constant Field Values

HEADER

public static final int HEADER
Element is in report header.

See Also:
Constant Field Values

FOOTER

public static final int FOOTER
Element is in report footer.

See Also:
Constant Field Values
Constructor Detail

PageLocation

public PageLocation()
New location at top of first page.


PageLocation

public PageLocation(int page)
Page location at the top of the page.

Parameters:
page - page number.

PageLocation

public PageLocation(int page,
                    int paintable)
Page location at the specified element item.

Parameters:
page - page number.
paintable - the index of the element.

PageLocation

public PageLocation(int page,
                    int paintable,
                    int row,
                    int region,
                    int y)
Page location at the specified element item.

Parameters:
page - page number.
paintable - the index of the element.
row - table row number.
region - page region - BODY, HEADER, FOOTER.
Method Detail

getPageIndex

public int getPageIndex()
Get the page index, starts from 0.

Returns:
page number.

setPageIndex

public void setPageIndex(int page)
Set the page index.

Parameters:
page - page number.

getPaintableIndex

public int getPaintableIndex()
Get the element paintable index.

Returns:
paintable index.

setPaintableIndex

public void setPaintableIndex(int paintable)
Set the element paintable index.

Parameters:
paintable - paintable index.

getRow

public int getRow()
Get the row number in table.

Returns:
row number.

setRow

public void setRow(int row)
Set the table row number.

Parameters:
row - table row number.

getY

public int getY()
Get the Y position on the page.


setY

public void setY(int y)
Set the Y position on the page.


getDescription

public String getDescription()
Get the description of the PageLocation.

Returns:
the description of the PageLocation

setDescription

public void setDescription(String description)
Set the description of the PageLocation.

Parameters:
description - the description

isInSection

public boolean isInSection()
Determines if this page location is in a section.

Returns:
true if this location is in a section.
Since:
7.0

setInSection

public void setInSection(boolean inSection)
Sets whether this page location is in a section.

Parameters:
inSection - true if this location is in a section.
Since:
7.0

isInTable

public boolean isInTable()
Determines if this page location is in a table.

Returns:
true if this location is in a table.
Since:
7.0

setInTable

public void setInTable(boolean inTable)
Sets whether this page location is in a table.

Parameters:
inTable - true if this location is in a table.
Since:
7.0

getPageRegion

public int getPageRegion()
Return the region of the page this PageLocation exists. Must of one of the constants BODY, HEADER, FOOTER.

Returns:
Region of page this location exists.

setPageRegion

public void setPageRegion(int region)
Set the region of the page this PageLocation exists. Must be one of the constants BODY, HEADER, FOOTER.

Parameters:
region - page region.

getURLString

public String getURLString()
Get the url String represents the PageLocation. It will be used as part of a url.

Returns:
the url String represents the PageLocation

parseURLString

public static PageLocation parseURLString(String str)
                                   throws NumberFormatException
Parse the url String represents a PageLocation to the represented PageLocation.

Parameters:
str - the url String represents a PageLocation
Returns:
the PageLocation represented by the url String
Throws:
NumberFormatException

toString

public String toString()
Overrides:
toString in class Object

clone

public Object clone()
Overrides:
clone in class Object

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