public class HtmlViewOptions extends ViewOptions
Provides options for rendering documents into HTML format.
Modifier and Type | Method and Description |
---|---|
static HtmlViewOptions |
forEmbeddedResources()
Initializes new instance of
HtmlViewOptions class. |
static HtmlViewOptions |
forEmbeddedResources(PageStreamFactory pageStreamFactory)
Initializes new instance of
HtmlViewOptions class for rendering into HTML with embedded resources. |
static HtmlViewOptions |
forEmbeddedResources(String filePathFormat)
Initializes new instance of
HtmlViewOptions class. |
static HtmlViewOptions |
forExternalResources()
Initializes new instance of
HtmlViewOptions class. |
static HtmlViewOptions |
forExternalResources(PageStreamFactory pageStreamFactory,
ResourceStreamFactory resourceStreamFactory)
Initializes new instance of
HtmlViewOptions class for rendering into HTML with external resources. |
static HtmlViewOptions |
forExternalResources(String filePathFormat,
String resourceFilePathFormat,
String resourceUrlFormat)
Initializes new instance of
HtmlViewOptions class. |
List<String> |
getFontsToExclude()
The list of font names, to exclude from HTML document.
|
boolean |
isEmbedResources() |
boolean |
isExcludeFonts()
When enabled prevents adding any fonts into HTML document.
|
boolean |
isExternalResources() |
boolean |
isForPrinting()
Indicates whether to optimize output HTML for printing.
|
boolean |
isMinify()
Enables HTML content and HTML resources minification.
|
boolean |
isRenderResponsive()
Enables responsive rendering;
Responsive web-pages render well on a devices with different screen size.
|
boolean |
isRenderSinglePage()
Enables HTML content will be rendered to single page
|
void |
setExcludeFonts(boolean value)
When enabled prevents adding any fonts into HTML document.
|
void |
setFontsToExclude(List<String> value)
The list of font names, to exclude from HTML document.
|
void |
setForPrinting(boolean value)
Indicates whether to optimize output HTML for printing.
|
void |
setMinify(boolean value)
Enables HTML content and HTML resources minification.
|
void |
setRenderResponsive(boolean value)
Enables responsive rendering;
Responsive web-pages render well on a devices with different screen size.
|
void |
setRenderSinglePage(boolean renderSinglePage)
Enables HTML content will be rendered to single page
|
getPageRotations, getWatermark, rotatePage, setWatermark
getArchiveOptions, getCadOptions, getDefaultFontName, getEmailOptions, getLotusNotesOptions, getOutlookOptions, getPdfOptions, getProjectManagementOptions, getSpreadsheetOptions, getWordProcessingOptions, isForHtmlView, isRenderComments, isRenderHiddenPages, isRenderNotes, setArchiveOptions, setCadOptions, setDefaultFontName, setEmailOptions, setForHtmlView, setLotusNotesOptions, setOutlookOptions, setPdfOptions, setProjectManagementOptions, setRenderComments, setRenderHiddenPages, setRenderNotes, setSpreadsheetOptions, setWordProcessingOptions
public static HtmlViewOptions forEmbeddedResources()
Initializes new instance of HtmlViewOptions
class.
public static HtmlViewOptions forEmbeddedResources(PageStreamFactory pageStreamFactory)
Initializes new instance of HtmlViewOptions
class for rendering into HTML with embedded resources.
pageStreamFactory
- The factory which implements methods for creating and releasing output page stream.HtmlViewOptions
class for rendering into HTML with embedded resources.IllegalArgumentException
- Thrown when pageStreamFactory
is null.public static HtmlViewOptions forEmbeddedResources(String filePathFormat)
Initializes new instance of HtmlViewOptions
class.
filePathFormat
- The file path format e.g. 'page_{0}.html'.IllegalArgumentException
- Thrown when filePathFormat
is null or empty.public static HtmlViewOptions forExternalResources()
Initializes new instance of HtmlViewOptions
class.
HtmlViewOptions
public static HtmlViewOptions forExternalResources(PageStreamFactory pageStreamFactory, ResourceStreamFactory resourceStreamFactory)
Initializes new instance of HtmlViewOptions
class for rendering into HTML with external resources.
pageStreamFactory
- The factory which implements methods for creating and releasing output page stream.resourceStreamFactory
- The factory which implements methods that are required for creating resource URL, instantiating and releasing output HTML resource stream.HtmlViewOptions
class for rendering into HTML with external resources.IllegalArgumentException
- Thrown when pageStreamFactory
is null.IllegalArgumentException
- Thrown when resourceStreamFactory
is null.public static HtmlViewOptions forExternalResources(String filePathFormat, String resourceFilePathFormat, String resourceUrlFormat)
Initializes new instance of HtmlViewOptions
class.
filePathFormat
- The file path format e.g. 'page_{0}.html'.resourceFilePathFormat
- The resource file path format e.g. 'page_{0}/resource_{1}'.resourceUrlFormat
- The resource URL format e.g. 'page_{0}/resource_{1}'.IllegalArgumentException
- Thrown when filePathFormat
is null or empty.IllegalArgumentException
- Thrown when resourceFilePathFormat
is null or empty.IllegalArgumentException
- Thrown when resourceUrlFormat
is null or empty.public final List<String> getFontsToExclude()
The list of font names, to exclude from HTML document.
ExcludeFonts
(isExcludeFonts()
/setExcludeFonts(boolean)
)
options is disabled.
public final boolean isEmbedResources()
public final boolean isExcludeFonts()
When enabled prevents adding any fonts into HTML document.
public final boolean isExternalResources()
public final boolean isForPrinting()
Indicates whether to optimize output HTML for printing.
public final boolean isMinify()
Enables HTML content and HTML resources minification.
public final boolean isRenderResponsive()
Enables responsive rendering; Responsive web-pages render well on a devices with different screen size.
public boolean isRenderSinglePage()
public final void setExcludeFonts(boolean value)
When enabled prevents adding any fonts into HTML document.
public final void setFontsToExclude(List<String> value)
The list of font names, to exclude from HTML document.
ExcludeFonts
(isExcludeFonts()
/setExcludeFonts(boolean)
)
options is disabled.
public final void setForPrinting(boolean value)
Indicates whether to optimize output HTML for printing.
public final void setMinify(boolean value)
Enables HTML content and HTML resources minification.
public final void setRenderResponsive(boolean value)
Enables responsive rendering; Responsive web-pages render well on a devices with different screen size.
public void setRenderSinglePage(boolean renderSinglePage)