org.eclipse.mylyn.wikitext.core.parser.builder
Class XslfoDocumentBuilder.Configuration

java.lang.Object
  extended by org.eclipse.mylyn.wikitext.core.parser.builder.XslfoDocumentBuilder.Configuration
All Implemented Interfaces:
Cloneable
Enclosing class:
XslfoDocumentBuilder

public static class XslfoDocumentBuilder.Configuration
extends Object
implements Cloneable

A class that encapsulates all configurable settings of the XslfoDocumentBuilder. This class implements the template design pattern via clone().

Author:
David Green

Constructor Summary
XslfoDocumentBuilder.Configuration()
           
 
Method Summary
 XslfoDocumentBuilder.Configuration clone()
           
 String getAuthor()
          an author to emit on the title page
 String getCopyright()
          a copyright to emit in the document page footer
 String getDate()
          a date to emit on the title page
 float getFontSize()
          Get the base font size.
 float[] getFontSizeMultipliers()
          The font size multipliers.
 float getPageHeight()
          The page height in cm.
 float getPageMargin()
          The page margin in cm.
 float getPageWidth()
          The page width in cm.
 String getSubTitle()
          a sub-title to be emitted on the title page
 String getTitle()
          a title to be emitted on the title page
 String getVersion()
          a document version number to emit on the title page
 boolean isPageBreakOnHeading1()
          Indicate if h1 headings should start a new page.
 boolean isPageNumbering()
          indicate if pages should be numbered
 boolean isPanelText()
          indicate if the text 'Note: ', 'Tip: ', and 'Warning: ' should be added to blocks of type BlockType#NOTE, BlockType#TIP, and BlockType#WARNING respectively.
 boolean isShowExternalLinks()
          indicate if external link URLs should be emitted in the text.
 boolean isUnderlineLinks()
          Indicate if links should be underlined.
 void setAuthor(String author)
          an author to emit on the title page
 void setCopyright(String copyright)
          a copyright to emit in the document page footer
 void setDate(String date)
          a date to emit on the title page
 void setFontSize(float fontSize)
          Set the base font size.
 void setFontSizeMultipliers(float[] fontSizeMultipliers)
          Set the font size multipliers.
 void setPageBreakOnHeading1(boolean pageBreakOnHeading1)
          Indicate if h1 headings should start a new page.
 void setPageHeight(float pageHeight)
          The page height in cm.
 void setPageMargin(float pageMargin)
          The page margin in cm.
 void setPageNumbering(boolean pageNumbering)
          indicate if pages should be numbered
 void setPageWidth(float pageWidth)
          The page width in cm.
 void setPanelText(boolean panelText)
          indicate if the text 'Note: ', 'Tip: ', and 'Warning: ' should be added to blocks of type BlockType#NOTE, BlockType#TIP, and BlockType#WARNING respectively.
 void setShowExternalLinks(boolean showExternalLinks)
          indicate if external link URLs should be emitted in the text.
 void setSubTitle(String subTitle)
          a sub-title to be emitted on the title page
 void setTitle(String title)
          a title to be emitted on the title page
 void setUnderlineLinks(boolean underlineLinks)
          Indicate if links should be underlined.
 void setVersion(String version)
          a document version number to emit on the title page
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XslfoDocumentBuilder.Configuration

public XslfoDocumentBuilder.Configuration()
Method Detail

clone

public XslfoDocumentBuilder.Configuration clone()
Overrides:
clone in class Object

setFontSize

public void setFontSize(float fontSize)
Set the base font size. The base font size is 10.0 by default


getFontSize

public float getFontSize()
Get the base font size. The base font size is 10.0 by default


setFontSizeMultipliers

public void setFontSizeMultipliers(float[] fontSizeMultipliers)
Set the font size multipliers. Multipliers are used to determine the actual size of fonts by multiplying the base font size by the multiplier to determine the size of a font for a heading.

Parameters:
fontSizeMultipliers - an array of size 7, where position 1-6 correspond to headings h1 to h6

getFontSizeMultipliers

public float[] getFontSizeMultipliers()
The font size multipliers. Multipliers are used to determine the actual size of fonts by multiplying the base font size by the multiplier to determine the size of a font for a heading.

Returns:
an array of size 7, where position 1-6 correspond to headings h1 to h6

isShowExternalLinks

public boolean isShowExternalLinks()
indicate if external link URLs should be emitted in the text. The default is true.


setShowExternalLinks

public void setShowExternalLinks(boolean showExternalLinks)
indicate if external link URLs should be emitted in the text. The default is true.


isUnderlineLinks

public boolean isUnderlineLinks()
Indicate if links should be underlined. The default is false.


setUnderlineLinks

public void setUnderlineLinks(boolean underlineLinks)
Indicate if links should be underlined. The default is false.


isPageBreakOnHeading1

public boolean isPageBreakOnHeading1()
Indicate if h1 headings should start a new page. The default is true.


setPageBreakOnHeading1

public void setPageBreakOnHeading1(boolean pageBreakOnHeading1)
Indicate if h1 headings should start a new page. The default is true.


getTitle

public String getTitle()
a title to be emitted on the title page


setTitle

public void setTitle(String title)
a title to be emitted on the title page


getSubTitle

public String getSubTitle()
a sub-title to be emitted on the title page


setSubTitle

public void setSubTitle(String subTitle)
a sub-title to be emitted on the title page


isPanelText

public boolean isPanelText()
indicate if the text 'Note: ', 'Tip: ', and 'Warning: ' should be added to blocks of type BlockType#NOTE, BlockType#TIP, and BlockType#WARNING respectively.


setPanelText

public void setPanelText(boolean panelText)
indicate if the text 'Note: ', 'Tip: ', and 'Warning: ' should be added to blocks of type BlockType#NOTE, BlockType#TIP, and BlockType#WARNING respectively.


getVersion

public String getVersion()
a document version number to emit on the title page


setVersion

public void setVersion(String version)
a document version number to emit on the title page


getDate

public String getDate()
a date to emit on the title page


setDate

public void setDate(String date)
a date to emit on the title page


getAuthor

public String getAuthor()
an author to emit on the title page


setAuthor

public void setAuthor(String author)
an author to emit on the title page


getCopyright

public String getCopyright()
a copyright to emit in the document page footer


setCopyright

public void setCopyright(String copyright)
a copyright to emit in the document page footer


isPageNumbering

public boolean isPageNumbering()
indicate if pages should be numbered


setPageNumbering

public void setPageNumbering(boolean pageNumbering)
indicate if pages should be numbered


getPageMargin

public float getPageMargin()
The page margin in cm. Defaults to 1.5cm.


setPageMargin

public void setPageMargin(float pageMargin)
The page margin in cm. Defaults to 1.5cm.


getPageHeight

public float getPageHeight()
The page height in cm. Defaults to A4 sizing (29.7cm)


setPageHeight

public void setPageHeight(float pageHeight)
The page height in cm. Defaults to A4 sizing (29.7cm)


getPageWidth

public float getPageWidth()
The page width in cm. Defaults to A4 sizing (21.0cm)


setPageWidth

public void setPageWidth(float pageWidth)
The page width in cm. Defaults to A4 sizing (21.0cm)



Copyright © 2011 FuseSource, Corp.. All Rights Reserved.