|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.mylyn.wikitext.core.parser.builder.XslfoDocumentBuilder.Configuration
public static class XslfoDocumentBuilder.Configuration
A class that encapsulates all configurable settings of the XslfoDocumentBuilder
. This class implements
the template design pattern via clone()
.
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 |
---|
public XslfoDocumentBuilder.Configuration()
Method Detail |
---|
public XslfoDocumentBuilder.Configuration clone()
clone
in class 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 String getTitle()
public void setTitle(String title)
public String getSubTitle()
public void setSubTitle(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 String getVersion()
public void setVersion(String version)
public String getDate()
public void setDate(String date)
public String getAuthor()
public void setAuthor(String author)
public String getCopyright()
public void setCopyright(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)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |