OptionalContentOrderArray Class Documentation
classOptionalContentOrderArray : OptionalContentOrderNodeNamespace:com::datalogics::PDFL
- Inherits from:
OptionalContentOrderNode
Detailed Description
Array node class for items in the OptionalContentConfig Order array. Items in the Order array can be arranged into a tree structure; subarrays within the parent array form 'branches' of the tree. Each OptionalContentOrderArray may contain OptionalContentOrderLeafs or OptionalContentOrderArrays in a specific order; this order determines how they will appear in the 'Layers' control of the viewer.
By placing OptionalContentOrderArrays into a higher-level array, branches can be added to the tree. The 'Title' property is a string that will appear next to the expand/collapse branch control in a PDF Viewer 'Layers' panel.
Referenced by
Uses types
Constructor & Destructor Documentation
OptionalContentOrderArray
OptionalContentOrderArray(Documentdoc)Parameters
doc: DocumentThe Document this OptionalContentOrderArray is being created in
Create an OptionalContentOrderArray with no title.
OptionalContentOrderArray
OptionalContentOrderArray(Documentdoc, Stringtitle)Parameters
doc: DocumentThe Document this OptionalContentOrderArray is being created in
title: StringThe string which will appear in the Layer control panel
Create an OptionalContentOrderArray with a title.
Member Function Documentation
DisposeChildren
voidDisposeChildren()Returns:
void[static initializer]
static void[static initializer]()add
voidadd(OptionalContentOrderNodenode)Parameters
node: OptionalContentOrderNodeThe OptionalContentOrderNode to append to the Array
Returns:
voidAdds an OptionalContentOrderNode to the end of the Array.
delete
synchronized voiddelete(Booleandisposing)Parameters
disposing: Boolean
Returns:
synchronized voiddelete
synchronized voiddelete()Returns:
synchronized voidfinalize
voidfinalize()Returns:
voidget
OptionalContentOrderNodeget(intindex)Parameters
index: intThe index at which to fetch an OptionalContentOrderNode.
Returns:
An OptionalContentOrderNode, or null if there is nothing at that index.Returns the OptionalContentOrderNode at the given index.
getLength
intgetLength()Returns:
intThe number of OptionalContentOrderNodes in this array.
getTitle
StringgetTitle()Returns:
The title string of this OptionalContentOrderArray.The title string of this Array. This title will appear next to the expand/collapse control in the 'Layers' panel of a PDF Viewer.
This field may be set null to remove the title.
insert
voidinsert(intindex, OptionalContentOrderNodenode)Parameters
index: intThe index at which to insert the Node
node: OptionalContentOrderNodeThe OptionalContentOrderNode to insert in the Array
Returns:
voidInserts an OptionalContentOrderNode at the given index, displacing existing objects. All objects following this will have their index increased by one.
put
voidput(intindex, OptionalContentOrderNodenode)Parameters
index: intThe index at which to replace the existing Node
node: OptionalContentOrderNodeThe OptionalContentOrderNode to place in the Array
Returns:
voidPuts an OptionalContentOrderNode at the given index, replacing the existing item. The index can be greater than the current length of the array; the array will be extended and the empty slots filled with null objects.
removeAt
voidremoveAt(intindex)Parameters
index: intThe index of the OptionalContentOrderNode to remove
Returns:
voidRemoves the OptionalContentOrderNode at the given index. The length of the array is reduced by 1.
setTitle
voidsetTitle(Stringtitle)Parameters
title: StringThe title string of this OptionalContentOrderArray.
Returns:
voidThe title string of this Array. This title will appear next to the expand/collapse control in the 'Layers' panel of a PDF Viewer.
This field may be set null to remove the title.