com.arctorus.documents
Class Page

java.lang.Object
  extended by com.arctorus.documents.Page

public final class Page
extends java.lang.Object

Page in a document.


Method Summary
 void addShape(Shape shape)
          Add new shape to a page.
 java.lang.String getName()
          Get name of the page.
 int getPageIndex()
          Return 0-based index of a page in a document.
 java.util.List<Shape> getShapes()
          Get list of all shapes on a page.
 Table getTable()
          Get table on the page.
 PageVisibilityType getVisibility()
          Get visibility of the page.
 void setName(java.lang.String pageName)
          Set name of the page.
 void setVisibility(PageVisibilityType pageVisibility)
          Set visibility of the page.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getPageIndex

public int getPageIndex()
Return 0-based index of a page in a document.


addShape

public void addShape(Shape shape)
Add new shape to a page.

Parameters:
shape - shape to add.

getShapes

public java.util.List<Shape> getShapes()
Get list of all shapes on a page.


getTable

public Table getTable()
Get table on the page. Can be used with XLSX and ODS formats only.


getName

public java.lang.String getName()
Get name of the page. Sheet name for spreadsheets, slide name for presentation.


setName

public void setName(java.lang.String pageName)
             throws java.lang.IllegalArgumentException
Set name of the page. Sheet name for spreadsheets, slide name for presentation. All page names must be unique in a document.

Parameters:
pageName - new name of the page.
Throws:
java.lang.IllegalArgumentException - in case such page name already exists in a document.

getVisibility

public PageVisibilityType getVisibility()
Get visibility of the page.


setVisibility

public void setVisibility(PageVisibilityType pageVisibility)
Set visibility of the page.

Parameters:
pageVisibility -