|
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.
- See also
- common::Renderer
◆ LayerContext() [1/2]
Constructor, based on a PDF document and specified layer usage type.
- Parameters
-
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. |
◆ LayerContext() [2/2]
com.foxit.sdk.pdf.LayerContext.LayerContext |
( |
LayerContext |
other | ) |
|
◆ copyStates()
Copy states from another layer context.
- Parameters
-
source_context | The source layer context, whose state will be copied to current layer context.
|
- Returns
- true means success, while false means failure.
◆ getDocument()
Get the related PDF document.
- Returns
- The related PDF document object.
◆ getUsageType()
Get the layer usage type for rendering.
- Returns
- Layer usage type. Please refer to values starting from e_UsageView and this would be one of these values except e_UsageZoom.
◆ isEmpty()
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.
- Returns
- true means current object is empty, while false means not.
◆ isVisible()
Check if a specified layer node is visible in current layer context.
- Parameters
-
layer | A layer node. It should belong to the same PDF document which is related to current layer context.
|
- Returns
- true means the layer node is visible, while false means the layer node is invisible.
◆ mergeStates()
Merge states from another layer context.
- Parameters
-
source_context | The source layer context, whose state will be merged to current layer context.
|
- Returns
- true means success, while false means failure.
◆ reset()
Reset current layer context, back to the initialized state.
- Returns
- true means success, while false means failure.
◆ setVisible()
Set the visibility of a specified layer node in current layer context.
- Parameters
-
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.
|
- Returns
- true means the layer node is visible, while false means the layer node is invisible.