Style Intelligence v12.0

inetsoft.report.event
Class PageBreakEvent

java.lang.Object
  extended by java.util.EventObject
      extended by inetsoft.report.event.PageBreakEvent
All Implemented Interfaces:
Serializable

public class PageBreakEvent
extends EventObject

PageBreakEvent is posted during page layout/printing at end of each page. A PageBreakListener can be registered with a ReportSheet to be notified at the end of every page.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
PageBreakEvent(Object source, int pgIdx, String eid, Rectangle reg, String first_eid, Rectangle first_reg, boolean lastpg, boolean rewinded)
          Create a selection event.
 
Method Summary
 String getElementID()
          Return the source report element ID.
 String getFirstElementID()
          Get the element ID of the first element on the page.
 EventRange getFirstRegion()
          Get the table region of the first element.
 int getPageIndex()
          Get the page index (starting from 0).
 EventRange getRegion()
          Get the table region of the last element.
 boolean isLastPage()
          Check if this is the end of last page.
 boolean isRewound()
          Check if the last band on the page has been rewound.
 String toString()
           
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PageBreakEvent

public PageBreakEvent(Object source,
                      int pgIdx,
                      String eid,
                      Rectangle reg,
                      String first_eid,
                      Rectangle first_reg,
                      boolean lastpg,
                      boolean rewinded)
Create a selection event.

Parameters:
source - event source, a StylePage.
pgIdx - page index (starting from 0).
eid - element ID.
reg - region of the last element.
first_eid - ID of the first element on the page.
first_reg - the table region of the first element.
lastpg - true if at the last page of report.
rewinded - true if the last band on the page has been rewound.
Method Detail

getPageIndex

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


getElementID

public String getElementID()
Return the source report element ID.

Returns:
element ID.

getRegion

public EventRange getRegion()
Get the table region of the last element. The x and y is the column and row numbers of the left-upper corner of the region (not including the header rows/columns). The width and height are the number of rows and columns in the region.

Returns:
row number.

getFirstElementID

public String getFirstElementID()
Get the element ID of the first element on the page.


getFirstRegion

public EventRange getFirstRegion()
Get the table region of the first element.


isLastPage

public boolean isLastPage()
Check if this is the end of last page.

Returns:
true if at the end of last page.

isRewound

public boolean isRewound()
Check if the last band on the page has been rewound.


toString

public String toString()
Overrides:
toString in class EventObject

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