Foxit PDF SDK
|
Public Member Functions | |
def | LayerTree (document) |
Constructor, from a PDF document. More... | |
def | GetDict () |
Get the dictionary of current object. More... | |
def | GetOCGs () |
Get the "OCGs" PDF array from current object. More... | |
def | GetRootNode () |
Get the root layer node. More... | |
def | IsEmpty () |
Check whether current object is empty or not. More... | |
def | SetBaseState (state) |
Set the base state for all layers in the default configuration. More... | |
Static Public Attributes | |
e_StateOFF = _fsdk.LayerTree_e_StateOFF | |
The state is OFF. | |
e_StateON = _fsdk.LayerTree_e_StateON | |
The state is ON. | |
e_StateUnchanged = _fsdk.LayerTree_e_StateUnchanged | |
The state is unchanged. | |
e_StateUndefined = _fsdk.LayerTree_e_StateUndefined | |
The state is undefined. | |
PDF layer nodes are stored in a PDF layer tree. If user wants to retrieve a layer node, user must construct a layer tree object from a PDF document first and then call function FoxitPDFSDKPython3.LayerTree.GetRootNode to get the root layer node of the whole layer tree. Then, user can enumerate all the nodes in the layer tree from the root layer node.
def FoxitPDFSDKPython3.LayerTree.LayerTree | ( | document | ) |
Constructor, from a PDF document.
Constructor, with another layer tree object.
The constructed layer tree object can be associated with existed layer tree in PDF document. If there is no layer tree in PDF document which can be judged by functoin FoxitPDFSDKPython3.PDFDoc.HasLayer , the constructed layer tree object will build layer related dictionary.
[in] | document | A valid PDF document object. |
[in] | other | Another layer tree object. |
def FoxitPDFSDKPython3.LayerTree.GetDict | ( | ) |
Get the dictionary of current object.
def FoxitPDFSDKPython3.LayerTree.GetOCGs | ( | ) |
Get the "OCGs" PDF array from current object.
def FoxitPDFSDKPython3.LayerTree.GetRootNode | ( | ) |
Get the root layer node.
After getting the root layer node, user can enumerate all layer nodes in current layer tree by functions of class LayerNode.
def FoxitPDFSDKPython3.LayerTree.IsEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
def FoxitPDFSDKPython3.LayerTree.SetBaseState | ( | state | ) |
Set the base state for all layers in the default configuration.
If user wants the new state to have effect on rendering result, please construct a new layer context object after this function succeeds, and then use the new LayerContext to Renderer to do rendering.
[in] | state | Layer usage state. Please refer to values starting from FoxitPDFSDKPython3.LayerTree.e_StateON and this should be one of these values except FoxitPDFSDKPython3.LayerTree.e_StateUndefined . |