public static class XslfoDocumentBuilder.Configuration
extends java.lang.Object
implements java.lang.Cloneable
XslfoDocumentBuilder
. This class implements
the template design pattern via clone()
.Constructor and Description |
---|
XslfoDocumentBuilder.Configuration() |
Modifier and Type | Method and Description |
---|---|
XslfoDocumentBuilder.Configuration |
clone() |
java.lang.String |
getAuthor()
an author to emit on the title page
|
XslfoDocumentBuilder.Region |
getBodyAfterRegion() |
XslfoDocumentBuilder.Region |
getBodyBeforeRegion() |
XslfoDocumentBuilder.Region |
getBodyEndRegion() |
XslfoDocumentBuilder.Margins |
getBodyMargins()
Returns the body margins.
|
XslfoDocumentBuilder.Region |
getBodyStartRegion() |
java.lang.String |
getCopyright()
a copyright to emit in the document page footer
|
java.lang.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.
|
XslfoDocumentBuilder.Margins |
getPageMargins()
Returns the margins of the master page.
|
float |
getPageWidth()
The page width in cm.
|
float |
getReferenceOrientation()
The reference-orientation property of the master page in degrees.
|
java.lang.String |
getSubTitle()
a sub-title to be emitted on the title page
|
java.lang.String |
getTitle()
a title to be emitted on the title page
|
java.lang.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(java.lang.String author)
an author to emit on the title page
|
void |
setBodyAfterRegion(XslfoDocumentBuilder.Region region) |
void |
setBodyBeforeRegion(XslfoDocumentBuilder.Region region) |
void |
setBodyEndRegion(XslfoDocumentBuilder.Region region) |
void |
setBodyMargins(XslfoDocumentBuilder.Margins bodyMargins)
Sets the body margins.
|
void |
setBodyStartRegion(XslfoDocumentBuilder.Region region) |
void |
setCopyright(java.lang.String copyright)
a copyright to emit in the document page footer
|
void |
setDate(java.lang.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 |
setPageMargins(XslfoDocumentBuilder.Margins pageMargins)
Sets the page margins.
|
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 |
setReferenceOrientation(float referenceOrientation)
Sets the reference-orientation property of the master page in degrees.
|
void |
setShowExternalLinks(boolean showExternalLinks)
indicate if external link URLs should be emitted in the text.
|
void |
setSubTitle(java.lang.String subTitle)
a sub-title to be emitted on the title page
|
void |
setTitle(java.lang.String title)
a title to be emitted on the title page
|
void |
setUnderlineLinks(boolean underlineLinks)
Indicate if links should be underlined.
|
void |
setVersion(java.lang.String version)
a document version number to emit on the title page
|
public XslfoDocumentBuilder.Configuration clone()
clone
in class java.lang.Object
public void setFontSize(float fontSize)
public float getFontSize()
public void setFontSizeMultipliers(float[] fontSizeMultipliers)
base font size
by the multiplier to determine the size of a font for a heading.fontSizeMultipliers
- an array of size 7, where position 1-6 correspond to headings h1 to h6public float[] getFontSizeMultipliers()
base font size
by the multiplier to determine the size of a font for a heading.public boolean isShowExternalLinks()
public void setShowExternalLinks(boolean showExternalLinks)
public boolean isUnderlineLinks()
public void setUnderlineLinks(boolean underlineLinks)
public boolean isPageBreakOnHeading1()
public void setPageBreakOnHeading1(boolean pageBreakOnHeading1)
public java.lang.String getTitle()
public void setTitle(java.lang.String title)
public java.lang.String getSubTitle()
public void setSubTitle(java.lang.String subTitle)
public boolean isPanelText()
BlockType#NOTE
, BlockType#TIP
, and BlockType#WARNING
respectively.public void setPanelText(boolean panelText)
BlockType#NOTE
, BlockType#TIP
, and BlockType#WARNING
respectively.public java.lang.String getVersion()
public void setVersion(java.lang.String version)
public java.lang.String getDate()
public void setDate(java.lang.String date)
public java.lang.String getAuthor()
public void setAuthor(java.lang.String author)
public java.lang.String getCopyright()
public void setCopyright(java.lang.String copyright)
public boolean isPageNumbering()
public void setPageNumbering(boolean pageNumbering)
public float getPageMargin()
public void setPageMargin(float pageMargin)
public float getPageHeight()
public void setPageHeight(float pageHeight)
public float getPageWidth()
public void setPageWidth(float pageWidth)
public void setReferenceOrientation(float referenceOrientation)
referenceOrientation
- the master page orientation in degrees.public float getReferenceOrientation()
public XslfoDocumentBuilder.Margins getPageMargins()
public XslfoDocumentBuilder.Margins getBodyMargins()
public void setPageMargins(XslfoDocumentBuilder.Margins pageMargins)
pageMargins
- the page margins.setPageMargin(float)
public void setBodyMargins(XslfoDocumentBuilder.Margins bodyMargins)
boduMargins
- the page margins.public void setBodyBeforeRegion(XslfoDocumentBuilder.Region region)
public XslfoDocumentBuilder.Region getBodyBeforeRegion()
public void setBodyAfterRegion(XslfoDocumentBuilder.Region region)
public XslfoDocumentBuilder.Region getBodyAfterRegion()
public void setBodyStartRegion(XslfoDocumentBuilder.Region region)
public XslfoDocumentBuilder.Region getBodyStartRegion()
public void setBodyEndRegion(XslfoDocumentBuilder.Region region)
public XslfoDocumentBuilder.Region getBodyEndRegion()
Copyright © 2007, 2013 David Green and others.
All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v1.0
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html