Class PDFNet.RoleMap
PDFNet.RoleMap
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
PDFNet.RoleMap(id)
RoleMap is a dictionary that maps the names of structure types used in the
document to their approximate equivalents in the set of standard structure
types.
|
| Method Attributes | Method Name and Description |
|---|---|
|
copy()
Copy Constructor
|
|
| <static> |
PDFNet.RoleMap.create(dict)
Initialize a RoleMap using an existing low-level Cos/SDF role map dictionary.
|
|
getDirectMap(type)
|
|
|
Returns the RoleMap dictionary.
|
|
|
isValid()
|
Class Detail
PDFNet.RoleMap(id)
RoleMap is a dictionary that maps the names of structure types used in the
document to their approximate equivalents in the set of standard structure
types.
- Parameters:
- id
Method Detail
{RoleMap}
copy()
Copy Constructor
- Returns:
- {RoleMap} A promise that resolves to an object of type: "RoleMap" (generated documentation)
<static>
{RoleMap}
PDFNet.RoleMap.create(dict)
Initialize a RoleMap using an existing low-level Cos/SDF role map dictionary.
- Parameters:
- {Obj} dict
- a low-level (SDF/Cos) RoleMap dictionary.
- Returns:
- {RoleMap} A promise that resolves to an object of type: "RoleMap" (generated documentation)
{string}
getDirectMap(type)
- Parameters:
- {string} type
- element type
- Returns:
- {string} A promise that resolves to the direct mapping of given StructElement type, or NULL if such mapping is not defined.
{Obj}
getSDFObj()
Returns the RoleMap dictionary.
- Returns:
- {Obj} A promise that resolves to the object to the underlying SDF/Cos dictionary.
{boolean}
isValid()
- Returns:
- {boolean} A promise that resolves to true if this is a valid (non-null) RoleMap, false otherwise. If the function returns false the underlying SDF/Cos object is null or is not valid and the RoleMap should be treated as NULL object.