Style Intelligence v12.0

inetsoft.report
Class PageLayout

java.lang.Object
  extended by inetsoft.report.PageLayout
All Implemented Interfaces:
Serializable, Cloneable

public class PageLayout
extends Object
implements Serializable, Cloneable

A page layout defines a set of page areas, which is the printable area on a page. It can also contain shapes to be draw on a page. The shapes are defined in this class.

A page layout can be inserted into a report as a PageLayoutElement. Once the page layout element is encountered during report processing, the page layout is put into effect. The report automatically advances to the next page, which is divided into printable sections according to the page layout setting.

A page layout can be associated with a particular element. This allows the page layout to change in middle of an element, e.g., between table sections. If a page layout is associated with an element, the page layout will be used to print all subsequent pages of an element after it starts. If the element is the first element on a page, then the page layout is used immediately on the current page.

See Also:
Serialized Form

Nested Class Summary
static class PageLayout.InfoShape
          An information shape.
static class PageLayout.InfoText
          An information text.
static class PageLayout.Line
          A line shape.
static class PageLayout.Oval
          An oval or circle shape.
static class PageLayout.Rectangle
          A rectangle shape.
static class PageLayout.Shape
          This class defines a shape on a page.
 
Constructor Summary
PageLayout()
          Create an empty page layout.
PageLayout(PageArea[] areas)
          Create a page layout with the specified page areas.
 
Method Summary
 Object clone()
           
 Integer getOrientation()
          Get the page orientation.
 PageArea[] getPageAreas()
          Get printable areas.
 PageLayout.Shape[] getShapes()
          Get the shapes to draw on this page.
 boolean isEmpty()
          Check if this page layout is defined.
 void print(StylePage pg)
          Paint the shapes on a page.
 void setOrientation(Integer orientation)
          Set the page orientation.
 void setPageAreas(PageArea[] areas)
          Set printable areas.
 void setShapes(PageLayout.Shape[] shapes)
          Set the shapes to draw on this page.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PageLayout

public PageLayout()
Create an empty page layout.


PageLayout

public PageLayout(PageArea[] areas)
Create a page layout with the specified page areas.

Method Detail

getOrientation

public Integer getOrientation()
Get the page orientation. This orientation is used when this page layout is applied to the report.


setOrientation

public void setOrientation(Integer orientation)
Set the page orientation. This is used to change the page orientation in middle of a report. The default orientation is controlled by the printing/presentation entry point. If the orientation is set to null, this page layout uses the default orientation.

Parameters:
orientation - a Integer object with value in StyleConstants.PORTRAIT or StyleConstants.LANDSCAPE.

getPageAreas

public PageArea[] getPageAreas()
Get printable areas.


setPageAreas

public void setPageAreas(PageArea[] areas)
Set printable areas.


getShapes

public PageLayout.Shape[] getShapes()
Get the shapes to draw on this page.


setShapes

public void setShapes(PageLayout.Shape[] shapes)
Set the shapes to draw on this page. Shape classes are defined in this class, e.g., PageLayout.Line.


print

public void print(StylePage pg)
Paint the shapes on a page.


isEmpty

public boolean isEmpty()
Check if this page layout is defined.


clone

public Object clone()
Overrides:
clone in class Object

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