com.lowagie.text.pdf
public class PdfStructureElement extends PdfStructureBase
Nested Class Summary | |
---|---|
class | PdfStructureElement.PdfStructureMC
A dictionary placed in the /K of a leaf structure element.
|
class | PdfStructureElement.PdfStructureObj
Another dictionary residing in the /K of a leaf element.
|
Field Summary | |
---|---|
boolean | hasPageMark |
Integer | mcid |
PdfStructureElement | parent |
PdfStructureTreeRoot | top |
Constructor Summary | |
---|---|
PdfStructureElement(PdfStructureElement parent, PdfName structureType)
Creates a new instance of PdfStructureElement. | |
PdfStructureElement(PdfStructureElement parent, PdfName structType, PdfIndirectReference ref)
Constructs a new Element with a predetermined reference | |
PdfStructureElement(PdfStructureTreeRoot parent, PdfName structureType)
Creates a new instance of PdfStructureElement. |
Method Summary | |
---|---|
void | checkKids()
Throw if this structure element is being used as a parent |
static PdfStructureElement | createNextElement(PdfStructureElement parent, PdfName structureType)
Creates a new element and immediately assigns it the next MCID.
|
int | getMCID()
Get/assign a marked content ID for this element.
|
PdfDictionary | getParent()
Gets the parent of this node. |
PdfWriter | getWriter()
Should never be null... |
void | init(PdfStructureBase parent, PdfName structureType) |
void | init(PdfStructureBase parent, PdfName structureType, PdfIndirectReference ref) |
void | setMarkedContent(PdfIndirectReference pageRef)
sets this structure element to represent a particular section of marked content
within the page indicated by pageRef |
void | setMarkedObject(PdfIndirectReference objRef, PdfIndirectReference pageRef)
Sets this StructElem up as a marked object. |
void | setMCID(int id)
Will throw if this element has >0 kids |
void | setObjMark() |
void | setPageMark(int page) |
Parameters: parent the parent of this node structureType the type of structure. It may be a standard type or a user type mapped by the role map
Parameters: parent structType ref
Since: 2.1.5
Parameters: parent the parent of this node structureType the type of structure. It may be a standard type or a user type mapped by the role map
Since: 2.1.5
Parameters: parent Structure Thing to contain the new element structureType durh.
Returns: the new element, with its freshly minted MCID already assigned. NOTE: There is no version of this function that can use the TreeRoot as its parent, because that would be silly. Think about it.
Since: 2.1.5
Returns: the elements marked content ID.
Since: 2.1.5
Returns: the parent of this node
Returns: Gee, I wonder.
Since: 2.1.5
Parameters: pageRef the reference to a particular page
Since: 2.1.5
Parameters: objRef required pageRef may be null
Since: 2.1.5
Parameters: id MCID
Since: 2.1.5
Since: 2.1.5
Parameters: page
Since: 2.1.5