PageStyle

java.lang.Object
- org.simpleods.PageStyle

```
public class PageStyle
extends java.lang.Object
```
Author:

Martin Schulz
Copyright 2008-2013 Martin Schulz
This file PageStyle.java is part of SimpleODS.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`STYLE_PAPERFORMAT_A3`
`static int`	`STYLE_PAPERFORMAT_A4`
`static int`	`STYLE_PAPERFORMAT_A5`
`static int`	`STYLE_PAPERFORMAT_LEGAL`
`static int`	`STYLE_PAPERFORMAT_LETTER`
`static int`	`STYLE_PAPERFORMAT_USER`
`static int`	`STYLE_PRINTORIENTATION_HORIZONTAL`
`static int`	`STYLE_PRINTORIENTATION_VERTICAL`
`static int`	`STYLE_WRITINGMODE_LR`
`static int`	`STYLE_WRITINGMODE_LRTB`
`static int`	`STYLE_WRITINGMODE_PAGE`
`static int`	`STYLE_WRITINGMODE_RL`
`static int`	`STYLE_WRITINGMODE_RLTB`
`static int`	`STYLE_WRITINGMODE_TB`
`static int`	`STYLE_WRITINGMODE_TBLR`
`static int`	`STYLE_WRITINGMODE_TBRL`

Constructor Summary

Constructors
Constructor and Description

PageStyle(java.lang.String sName, OdsFile odsFile)
Create a new page style.

Constructors
Constructor and Description
`PageStyle(java.lang.String sName, OdsFile odsFile)` Create a new page style.

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getBackgroundColor()`
`java.lang.String`	`getMarginBottom()`
`java.lang.String`	`getMarginLeft()`
`java.lang.String`	`getMarginRight()`
`java.lang.String`	`getMarginTop()`
`java.lang.String`	`getName()` Get the name of this page style.
`java.lang.String`	`getPageHeight()`
`java.lang.String`	`getPageWidth()`
`int`	`getPaperFormat()` Get the paper format as one of PageStyle.STYLE_PAPERFORMAT_*.
`int`	`getWritingMode()` Get the writing mode .
`void`	`setAllMargins(java.lang.String margin)` Set the margin at the top,bottom,left and right.
`void`	`setBackgroundColor(java.lang.String sColor)` Set the background color to sColor, a six-digit hex value.
`void`	`setMarginBottom(java.lang.String margin)` Set the margin at the bottom.
`void`	`setMarginLeft(java.lang.String margin)` Set the margin at the left.
`void`	`setMarginRight(java.lang.String margin)` Set the margin at the right.
`void`	`setMarginTop(java.lang.String margin)` Set the margin at the top.
`void`	`setPageHeight(java.lang.String pageHeight)` Set the page height.
`void`	`setPageWidth(java.lang.String pageWidth)` Set the page width.
`void`	`setPaperFormat(int nPaperFormat)` Set the paper format to one of PageStyle.STYLE_PAPERFORMAT_A3 PageStyle.STYLE_PAPERFORMAT_A4 PageStyle.STYLE_PAPERFORMAT_A5 PageStyle.STYLE_PAPERFORMAT_LETTER PageStyle.STYLE_PAPERFORMAT_LEGAL PageStyle.STYLE_PAPERFORMAT_USER , automatically used if you use setPageHeight() or setPageWidth().
`void`	`setPrintOrientationHorizontal()`
`void`	`setPrintOrientationVertical()`
`void`	`setWritingMode(int writingMode)` Set the writing mode to one of STYLE_WRITINGMODE_LRTB lr-tb (left to right; top to bottom) STYLE_WRITINGMODE_RLTB STYLE_WRITINGMODE_TBRL STYLE_WRITINGMODE_TBLR STYLE_WRITINGMODE_LR STYLE_WRITINGMODE_RL STYLE_WRITINGMODE_TB STYLE_WRITINGMODE_PAGE

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - STYLE_PAPERFORMAT_A3
```
public static final int STYLE_PAPERFORMAT_A3
```
    See Also:
    Constant Field Values
  - STYLE_PAPERFORMAT_A4
```
public static final int STYLE_PAPERFORMAT_A4
```
    See Also:
    Constant Field Values
  - STYLE_PAPERFORMAT_A5
```
public static final int STYLE_PAPERFORMAT_A5
```
    See Also:
    Constant Field Values
  - STYLE_PAPERFORMAT_LETTER
```
public static final int STYLE_PAPERFORMAT_LETTER
```
    See Also:
    Constant Field Values
  - STYLE_PAPERFORMAT_LEGAL
```
public static final int STYLE_PAPERFORMAT_LEGAL
```
    See Also:
    Constant Field Values
  - STYLE_PAPERFORMAT_USER
```
public static final int STYLE_PAPERFORMAT_USER
```
    See Also:
    Constant Field Values
  - STYLE_PRINTORIENTATION_VERTICAL
```
public static final int STYLE_PRINTORIENTATION_VERTICAL
```
    See Also:
    Constant Field Values
  - STYLE_PRINTORIENTATION_HORIZONTAL
```
public static final int STYLE_PRINTORIENTATION_HORIZONTAL
```
    See Also:
    Constant Field Values
  - STYLE_WRITINGMODE_LRTB
```
public static final int STYLE_WRITINGMODE_LRTB
```
    See Also:
    Constant Field Values
  - STYLE_WRITINGMODE_RLTB
```
public static final int STYLE_WRITINGMODE_RLTB
```
    See Also:
    Constant Field Values
  - STYLE_WRITINGMODE_TBRL
```
public static final int STYLE_WRITINGMODE_TBRL
```
    See Also:
    Constant Field Values
  - STYLE_WRITINGMODE_TBLR
```
public static final int STYLE_WRITINGMODE_TBLR
```
    See Also:
    Constant Field Values
  - STYLE_WRITINGMODE_LR
```
public static final int STYLE_WRITINGMODE_LR
```
    See Also:
    Constant Field Values
  - STYLE_WRITINGMODE_RL
```
public static final int STYLE_WRITINGMODE_RL
```
    See Also:
    Constant Field Values
  - STYLE_WRITINGMODE_TB
```
public static final int STYLE_WRITINGMODE_TB
```
    See Also:
    Constant Field Values
  - STYLE_WRITINGMODE_PAGE
```
public static final int STYLE_WRITINGMODE_PAGE
```
    See Also:
    Constant Field Values
- Constructor Detail
  - PageStyle
```
public PageStyle(java.lang.String sName,
         OdsFile odsFile)
```
    Create a new page style. Version 0.5.0 Added parameter OdsFile o
    
    Parameters:
    sName - A unique name for this style
- Method Detail
  - setPrintOrientationVertical
```
public void setPrintOrientationVertical()
```
  - setPrintOrientationHorizontal
```
public void setPrintOrientationHorizontal()
```
  - getPaperFormat
```
public int getPaperFormat()
```
    Get the paper format as one of PageStyle.STYLE_PAPERFORMAT_*.
  - setPaperFormat
```
public void setPaperFormat(int nPaperFormat)
```
    Set the paper format to one of
    PageStyle.STYLE_PAPERFORMAT_A3
    PageStyle.STYLE_PAPERFORMAT_A4
    PageStyle.STYLE_PAPERFORMAT_A5
    PageStyle.STYLE_PAPERFORMAT_LETTER
    PageStyle.STYLE_PAPERFORMAT_LEGAL
    PageStyle.STYLE_PAPERFORMAT_USER , automatically used if you use setPageHeight() or setPageWidth().
    
    Parameters:
    nPaperFormat -
  - getWritingMode
```
public int getWritingMode()
```
    Get the writing mode
    . STYLE_WRITINGMODE_LRTB lr-tb (left to right; top to bottom)
    STYLE_WRITINGMODE_RLTB
    STYLE_WRITINGMODE_TBRL
    STYLE_WRITINGMODE_TBLR
    STYLE_WRITINGMODE_LR
    STYLE_WRITINGMODE_RL
    STYLE_WRITINGMODE_TB
    STYLE_WRITINGMODE_PAGE
    
    Returns:
    The current writing mode.
  - setWritingMode
```
public void setWritingMode(int writingMode)
```
    Set the writing mode to one of
    STYLE_WRITINGMODE_LRTB lr-tb (left to right; top to bottom)
    STYLE_WRITINGMODE_RLTB
    STYLE_WRITINGMODE_TBRL
    STYLE_WRITINGMODE_TBLR
    STYLE_WRITINGMODE_LR
    STYLE_WRITINGMODE_RL
    STYLE_WRITINGMODE_TB
    STYLE_WRITINGMODE_PAGE
    
    Parameters:
    writingMode -
  - getPageHeight
```
public java.lang.String getPageHeight()
```
  - setPageHeight
```
public void setPageHeight(java.lang.String pageHeight)
```
    Set the page height. pageHeight is a length value expressed as a number followed by a unit of measurement e.g. 1.5cm or 12px
    The valid units in OpenDocument are in, cm, mm, px (pixels), pc (picas; 6 picas equals one inch), and pt (points; 72points equal one inch).
    When using this method, the paper format is set to PageStyle.STYLE_PAPERFORMAT_USER
    
    Parameters:
    pageHeight -
  - getPageWidth
```
public java.lang.String getPageWidth()
```
  - setPageWidth
```
public void setPageWidth(java.lang.String pageWidth)
```
    Set the page width. pageWidth is a length value expressed as a number followed by a unit of measurement e.g. 1.5cm or 12px
    The valid units in OpenDocument are in, cm, mm, px (pixels), pc (picas; 6 picas equals one inch), and pt (points; 72points equal one inch).
    When using this method, the paper format is set to PageStyle.STYLE_PAPERFORMAT_USER
    
    Parameters:
    pageWidth -
  - getMarginBottom
```
public java.lang.String getMarginBottom()
```
  - setMarginBottom
```
public void setMarginBottom(java.lang.String margin)
```
    Set the margin at the bottom. margin is a length value expressed as a number followed by a unit of measurement e.g. 1.5cm or 12px
    The valid units in OpenDocument are in, cm, mm, px (pixels), pc (picas; 6 picas equals one inch), and pt (points; 72points equal one inch).
    
    Parameters:
    margin -
  - getMarginLeft
```
public java.lang.String getMarginLeft()
```
  - setMarginLeft
```
public void setMarginLeft(java.lang.String margin)
```
    Set the margin at the left. margin is a length value expressed as a number followed by a unit of measurement e.g. 1.5cm or 12px
    The valid units in OpenDocument are in, cm, mm, px (pixels), pc (picas; 6 picas equals one inch), and pt (points; 72points equal one inch).
    
    Parameters:
    margin -
  - getMarginRight
```
public java.lang.String getMarginRight()
```
  - setMarginRight
```
public void setMarginRight(java.lang.String margin)
```
    Set the margin at the right. margin is a length value expressed as a number followed by a unit of measurement e.g. 1.5cm or 12px
    The valid units in OpenDocument are in, cm, mm, px (pixels), pc (picas; 6 picas equals one inch),
    and pt (points; 72points equal one inch).
    
    Parameters:
    margin -
  - getMarginTop
```
public java.lang.String getMarginTop()
```
  - setMarginTop
```
public void setMarginTop(java.lang.String margin)
```
    Set the margin at the top. margin is a length value expressed as a number followed by a unit of measurement e.g. 1.5cm or 12px
    The valid units in OpenDocument are in, cm, mm, px (pixels), pc (picas; 6 picas equals one inch),
    and pt (points; 72points equal one inch).
    
    Parameters:
    margin -
  - setAllMargins
```
public void setAllMargins(java.lang.String margin)
```
    Set the margin at the top,bottom,left and right. margin is a length value expressed as a number followed by a unit of measurement e.g. 1.5cm or 12px
    The valid units in OpenDocument are in, cm, mm, px (pixels), pc (picas; 6 picas equals one inch),
    and pt (points; 72points equal one inch).
    
    Parameters:
    margin -
  - getBackgroundColor
```
public java.lang.String getBackgroundColor()
```
  - setBackgroundColor
```
public void setBackgroundColor(java.lang.String sColor)
```
    Set the background color to sColor, a six-digit hex value. Example: #aa32f0.
    The background color may also be set to 'transparent' if a background image is used (currently unsupported).
    
    Parameters:
    sColor -
  - getName
```
public java.lang.String getName()
```
    Get the name of this page style.
    
    Returns:
    The page style name

Class PageStyle

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STYLE_PAPERFORMAT_A3

STYLE_PAPERFORMAT_A4

STYLE_PAPERFORMAT_A5

STYLE_PAPERFORMAT_LETTER

STYLE_PAPERFORMAT_LEGAL

STYLE_PAPERFORMAT_USER

STYLE_PRINTORIENTATION_VERTICAL

STYLE_PRINTORIENTATION_HORIZONTAL

STYLE_WRITINGMODE_LRTB

STYLE_WRITINGMODE_RLTB

STYLE_WRITINGMODE_TBRL

STYLE_WRITINGMODE_TBLR

STYLE_WRITINGMODE_LR

STYLE_WRITINGMODE_RL

STYLE_WRITINGMODE_TB

STYLE_WRITINGMODE_PAGE

Constructor Detail

PageStyle

Method Detail

setPrintOrientationVertical

setPrintOrientationHorizontal

getPaperFormat

setPaperFormat

getWritingMode

setWritingMode

getPageHeight

setPageHeight

getPageWidth

setPageWidth

getMarginBottom

setMarginBottom

getMarginLeft

setMarginLeft

getMarginRight

setMarginRight

getMarginTop

setMarginTop

setAllMargins

getBackgroundColor

setBackgroundColor

getName