Class PDFNet.NameTree
PDFNet.NameTree
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
PDFNet.NameTree(id)
A NameTree is a common data structure in PDF.
|
| Method Attributes | Method Name and Description |
|---|---|
|
copy()
Assignment operator
|
|
| <static> |
PDFNet.NameTree.create(doc, name)
Retrieves the NameTree inside the '/Root/Names' dictionary with the
specified key name, or creates it if it does not exist.
|
| <static> |
PDFNet.NameTree.createFromObj(name_tree)
Create a high level NameTree wrapper around an existing SDF/Cos NameTree.
|
|
erase(pos)
Removes the NameTree entry pointed by the iterator.
|
|
|
eraseKey(key)
[Documentation Not Yet Added]
|
|
| <static> |
PDFNet.NameTree.find(doc, name)
Retrieves a name tree, with the given key name, from the '/Root/Names'
dictionary of the doc.
|
|
getIterator(key)
[Documentation Not Yet Added]
|
|
|
getValue(key)
[Documentation Not Yet Added]
|
|
|
isValid()
|
|
|
put(key, value)
[Documentation Not Yet Added]
|
Class Detail
PDFNet.NameTree(id)
A NameTree is a common data structure in PDF. See section 3.8.5 'Name Trees'
in PDF Reference Manual for more details.
A name tree serves a similar purpose to a dictionary - associating keys and
values - but by different means. NameTrees allow efficient storage of very
large association collections (string/Obj* maps). A NameTree can have many
more entries than a SDF/Cos dictionary can.
NameTree-s use SDF/Cos-style strings (not null-terminated C strings), which
may use Unicode encoding etc.
- Parameters:
- id
Method Detail
{NameTree}
copy()
Assignment operator
- Returns:
- {NameTree} A promise that resolves to an object of type: "NameTree" (generated documentation)
<static>
{NameTree}
PDFNet.NameTree.create(doc, name)
Retrieves the NameTree inside the '/Root/Names' dictionary with the
specified key name, or creates it if it does not exist.
- Parameters:
- {SDFDoc} doc
- The document in which the name tree is created.
- {string} name
- The name of the NameTree to create.
- Returns:
- {NameTree} A promise that resolves to the newly created NameTree for the doc or an existing tree with the same key name.
<static>
{NameTree}
PDFNet.NameTree.createFromObj(name_tree)
Create a high level NameTree wrapper around an existing SDF/Cos NameTree.
This does not copy the object.
- Parameters:
- {Obj} name_tree
- SDF/Cos root of the NameTree object.
- Returns:
- {NameTree} A promise that resolves to an object of type: "NameTree" (generated documentation)
erase(pos)
Removes the NameTree entry pointed by the iterator.
- Parameters:
- {DictIterator} pos
- ditionary iterator object that points to the NameTree entry to be removed.
eraseKey(key)
[Documentation Not Yet Added]
- Parameters:
- {string} key
- (generated documentation)
<static>
{NameTree}
PDFNet.NameTree.find(doc, name)
Retrieves a name tree, with the given key name, from the '/Root/Names'
dictionary of the doc.
- Parameters:
- {SDFDoc} doc
- The document in which to search for the name.
- {string} name
- The name of the name tree to find.
- Returns:
- {NameTree} A promise that resolves to the requested NameTree. If the requested NameTree exists NameTree.IsValid() will return true, and false otherwise.
{DictIterator}
getIterator(key)
[Documentation Not Yet Added]
- Parameters:
- {string} key
- (generated documentation)
- Returns:
- {DictIterator} A promise that resolves to an object of type: "DictIterator" (generated documentation)
{DictIterator}
getIteratorBegin()
- Returns:
- {DictIterator} A promise that resolves to an iterator that addresses the first element in the NameTree. The iterator can be used to traverse all entries stored in the NameTree.
{Obj}
getSDFObj()
- Returns:
- {Obj} A promise that resolves to the object to the underlying SDF/Cos object. If the NameTree.IsValid() returns false the SDF/Cos object is NULL.
{Obj}
getValue(key)
[Documentation Not Yet Added]
- Parameters:
- {string} key
- (generated documentation)
- Returns:
- {Obj} A promise that resolves to an object of type: "Obj" (generated documentation)
{boolean}
isValid()
- Returns:
- {boolean} A promise that resolves to whether this is a valid (non-null) NameTree. If the function returns false the underlying SDF/Cos object is null and the NameTree object should be treated as null as well.
put(key, value)
[Documentation Not Yet Added]
- Parameters:
- {string} key
- (generated documentation)
- {Obj} value
- (generated documentation)