org.pentaho.reporting.engine.classic.core.modules.output.table.base
Class SheetLayoutCollection

java.lang.Object
  extended by org.pentaho.reporting.engine.classic.core.modules.output.table.base.SheetLayoutCollection

Deprecated. no longer used. Will be removed in the next release.

public class SheetLayoutCollection
extends Object

The tablelayout info class is used to store the layout that was generated in the repagination process. This layout can be shared over several pages to unify the look of the tables.

Author:
Thomas Morgner

Constructor Summary
SheetLayoutCollection(boolean useGlobalLayout)
          Deprecated. Creates a new tablelayout info object to store the layout information.
 
Method Summary
 void addLayout(SheetLayout bounds)
          Deprecated. Adds a layout for the next page to the layout information.
 SheetLayout getLayoutForPage(int page)
          Deprecated. Returns the layout for a given page.
 int getPageCount()
          Deprecated. Return the number of pages stored in that list.
 boolean isGlobalLayout()
          Deprecated. Checks whether to define a global layout.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SheetLayoutCollection

public SheetLayoutCollection(boolean useGlobalLayout)
Deprecated. 
Creates a new tablelayout info object to store the layout information.

Parameters:
useGlobalLayout - whether to use a global layout for all pages
Method Detail

addLayout

public void addLayout(SheetLayout bounds)
Deprecated. 
Adds a layout for the next page to the layout information.

Parameters:
bounds - the layout.

isGlobalLayout

public boolean isGlobalLayout()
Deprecated. 
Checks whether to define a global layout.

Returns:
true, if the report uses an global layout, false otherwise.

getLayoutForPage

public SheetLayout getLayoutForPage(int page)
Deprecated. 
Returns the layout for a given page. This returns the same layout for all pages if the globallayout feature is enabled.

Parameters:
page - the page for that the layout is requested.
Returns:
the stored layout.
Throws:
IndexOutOfBoundsException - if the page is invalid.

getPageCount

public int getPageCount()
Deprecated. 
Return the number of pages stored in that list. This returns 1 if the global layout is active.

Returns:
the number of pages.