Public Member Functions | |
LayerContext (PDFDoc document, int usage_type) throws com.foxit.sdk.PDFException | |
Constructor, based on a PDF document and specified layer usage type. More... | |
LayerContext (LayerContext other) | |
Constructor, with another LayerContext object. More... | |
boolean | copyStates (LayerContext source_context) throws com.foxit.sdk.PDFException |
Copy states from another layer context. More... | |
PDFDoc | getDocument () throws com.foxit.sdk.PDFException |
Get the related PDF document. More... | |
int | getUsageType () throws com.foxit.sdk.PDFException |
Get the layer usage type for rendering. More... | |
boolean | isEmpty () |
Check whether current object is empty or not. More... | |
boolean | isVisible (LayerNode layer) throws com.foxit.sdk.PDFException |
Check if a specified layer node is visible in current layer context. More... | |
boolean | mergeStates (LayerContext source_context) throws com.foxit.sdk.PDFException |
Merge states from another layer context. More... | |
boolean | reset () throws com.foxit.sdk.PDFException |
Reset current layer context, back to the initialized state. More... | |
boolean | setVisible (LayerNode layer, boolean is_visible) throws com.foxit.sdk.PDFException |
Set the visibility of a specified layer node in current layer context. More... | |
Static Public Attributes | |
static final int | e_UsageDesign = 0x0001 |
Use for representing a document designer's structural organization of artwork. | |
static final int | e_UsageExport = 0x0003 |
Use for exporting. | |
static final int | e_UsagePrint = 0x0002 |
Use for printing. | |
static final int | e_UsageView = 0x0000 |
Use for a viewer. | |
static final int | e_UsageZoom = 0x0004 |
Use for zooming. | |
This class represents a layer context for rendering. If user wants to render layers, please construct a LayerContext first and then set it to a common::Renderer object by function common::Renderer::setLayerContext.
com.foxit.sdk.pdf.LayerContext.LayerContext | ( | PDFDoc | document, |
int | usage_type | ||
) | throws com.foxit.sdk.PDFException |
Constructor, based on a PDF document and specified layer usage type.
document | A valid PDF document object. |
usage_type | Layer usage type. Please refer to values starting from e_UsageView and this should be one of these values except e_UsageZoom. |
com.foxit.sdk.pdf.LayerContext.LayerContext | ( | LayerContext | other | ) |
Constructor, with another LayerContext object.
other | Another LayerContext object. |
boolean com.foxit.sdk.pdf.LayerContext.copyStates | ( | LayerContext | source_context | ) | throws com.foxit.sdk.PDFException |
Copy states from another layer context.
source_context | The source layer context, whose state will be copied to current layer context. |
PDFDoc com.foxit.sdk.pdf.LayerContext.getDocument | ( | ) | throws com.foxit.sdk.PDFException |
Get the related PDF document.
int com.foxit.sdk.pdf.LayerContext.getUsageType | ( | ) | throws com.foxit.sdk.PDFException |
Get the layer usage type for rendering.
boolean com.foxit.sdk.pdf.LayerContext.isEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
boolean com.foxit.sdk.pdf.LayerContext.isVisible | ( | LayerNode | layer | ) | throws com.foxit.sdk.PDFException |
Check if a specified layer node is visible in current layer context.
layer | A layer node. It should belong to the same PDF document which is related to current layer context. |
boolean com.foxit.sdk.pdf.LayerContext.mergeStates | ( | LayerContext | source_context | ) | throws com.foxit.sdk.PDFException |
Merge states from another layer context.
source_context | The source layer context, whose state will be merged to current layer context. |
boolean com.foxit.sdk.pdf.LayerContext.reset | ( | ) | throws com.foxit.sdk.PDFException |
Reset current layer context, back to the initialized state.
boolean com.foxit.sdk.pdf.LayerContext.setVisible | ( | LayerNode | layer, |
boolean | is_visible | ||
) | throws com.foxit.sdk.PDFException |
Set the visibility of a specified layer node in current layer context.
layer | A layer node. It should belong to the same PDF document which is related to current layer context. |
is_visible | true means visible, and false means invisible. |