Interface IPDFRenderOption
- All Superinterfaces:
IRenderOption,ITaskOption
- All Known Implementing Classes:
PDFRenderOption
Defines render options for PDF emitter.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final StringThe option to disable flash animation.static final StringThe option to disable print.static final StringThe customer defined DPI setting for image display.static final intstatic final StringDeprecated.Scale the content to fit into the page, when the content exceeds page size.static final intstatic final StringDeprecated.define the font directory used by PDF.static final StringDeprecated.should the true-type font be embedded into the generated PDF file.static final intstatic final StringProperties to control how to output the content if the content exceeds the page-size.static final StringDeprecated.The flag to indicate whether PDF layout use auto page break or not.static final StringIf it is set to false, no BIDI processing is used.static final StringIf it is set to false, we needn't check if the character exists in the selected font.static final Stringdefine the PDF page count limit, it should be an Integer objectstatic final StringIf it is set to false, all the text should be displayed into one line, the text which can not be displayed in the line will be clipped.static final StringIf it is set to false, no word break is used.static final StringThe option to let PDF emitter choose to "render all pages" or "render page by page".static final StringThe layout uses the page number from the report document.Fields inherited from interface org.eclipse.birt.report.engine.api.IRenderOption
ACTION_HANDLER, APP_BASE_URL, BASE_URL, CHART_DPI, CLOSE_OUTPUTSTREAM_ON_EXIT, EMITTER_ID, HTML_PAGINATION, IMAGE_HANDLER, LOCALE, OUTPUT_DISPLAY_NONE, OUTPUT_EMITTERID_HTML, OUTPUT_EMITTERID_PDF, OUTPUT_FILE_NAME, OUTPUT_FORMAT, OUTPUT_FORMAT_FO, OUTPUT_FORMAT_HTML, OUTPUT_FORMAT_PDF, OUTPUT_STREAM, RENDER_DPI, REPORTLET_SIZE, RTL_FLAG, SUPPORTED_IMAGE_FORMATS -
Method Summary
Modifier and TypeMethodDescriptionDeprecated.booleanDeprecated.voidsetEmbededFont(boolean isEmbededFont) Deprecated.voidsetFontDirectory(String fontDirectory) Deprecated.Methods inherited from interface org.eclipse.birt.report.engine.api.IRenderOption
getActionHandle, getActionHandler, getAppBaseURL, getBaseURL, getEmitterID, getImageHandle, getImageHandler, getOutputFileName, getOutputFormat, getOutputSetting, getOutputStream, getSupportedImageFormats, setActionHandle, setActionHandler, setAppBaseURL, setBaseURL, setEmitterID, setImageHandle, setImageHandler, setOutputFileName, setOutputFormat, setOutputStream, setSupportedImageFormatsMethods inherited from interface org.eclipse.birt.report.engine.api.ITaskOption
getOption, getOptions, hasOption, setOption
-
Field Details
-
FIT_TO_PAGE
Deprecated.Scale the content to fit into the page, when the content exceeds page size. This property has been deprecated, please set PAGE_OVERFLOW = FIT_TO_PAGE_SIZE instead.- See Also:
-
PAGEBREAK_PAGINATION_ONLY
Deprecated.The flag to indicate whether PDF layout use auto page break or not. if it is set to true, then auto page break will not take effect. This property has been deprecated, please set PAGE_OVERFLOW = OUTPUT_TO_MULTIPLE_PAGES instead.- See Also:
-
PAGE_OVERFLOW
Properties to control how to output the content if the content exceeds the page-size. CLIP_CONTENT: clip the content FIT_TO_PAGE_SIZE: scale the content to fit into the page OUTPUT_TO_MULTIPLE_PAGES: divided the content into multiple pages ENLARGE_PAGE_SIZE: enlarge the page size to contain all the content.- See Also:
-
CLIP_CONTENT
static final int CLIP_CONTENT- See Also:
-
FIT_TO_PAGE_SIZE
static final int FIT_TO_PAGE_SIZE- See Also:
-
OUTPUT_TO_MULTIPLE_PAGES
static final int OUTPUT_TO_MULTIPLE_PAGES- See Also:
-
ENLARGE_PAGE_SIZE
static final int ENLARGE_PAGE_SIZE- See Also:
-
PDF_PAGE_LIMIT
define the PDF page count limit, it should be an Integer object- See Also:
-
PDF_TEXT_WRAPPING
If it is set to false, all the text should be displayed into one line, the text which can not be displayed in the line will be clipped.- See Also:
-
PDF_WORDBREAK
If it is set to false, no word break is used. The word longer than the line width will be clipped at the line boundary.- See Also:
-
PDF_FONT_SUBSTITUTION
If it is set to false, we needn't check if the character exists in the selected font.- See Also:
-
PDF_BIDI_PROCESSING
If it is set to false, no BIDI processing is used.- See Also:
-
DPI
The customer defined DPI setting for image display.- See Also:
-
RESERVE_DOCUMENT_PAGE_NUMBERS
The layout uses the page number from the report document. If it is false, use the page number generated by layout engine.- See Also:
-
REPAGINATE_FOR_PDF
The option to let PDF emitter choose to "render all pages" or "render page by page". It is false by default, corresponding to "render all pages".- See Also:
-
FONT_DIRECTORY
Deprecated.define the font directory used by PDF.- See Also:
-
IS_EMBEDDED_FONT
Deprecated.should the true-type font be embedded into the generated PDF file.- See Also:
-
DISABLE_FLASH_ANIMATION
The option to disable flash animation. Set this option to true for PDF printing.- See Also:
-
DISABLE_PRINT
The option to disable print.- See Also:
-
-
Method Details
-
setEmbededFont
Deprecated.- Parameters:
isEmbededFont-
-
isEmbededFont
Deprecated.- Returns:
- if font is embedded
-
getFontDirectory
Deprecated.- Returns:
- the user-defined font directory
-
setFontDirectory
Deprecated.- Parameters:
fontDirectory- the user-defined font directory
-