org.apache.pdfbox.pdmodel.documentinterchange.markedcontent
Class PDMarkedContent

java.lang.Object
  extended by org.apache.pdfbox.pdmodel.documentinterchange.markedcontent.PDMarkedContent
Direct Known Subclasses:
PDArtifactMarkedContent

public class PDMarkedContent
extends java.lang.Object

A marked content.

Version:
$Revision: $
Author:
Johannes Koch

Constructor Summary
PDMarkedContent(COSName tag, COSDictionary properties)
          Creates a new marked content object.
 
Method Summary
 void addMarkedContent(PDMarkedContent markedContent)
          Adds a marked content to the contents.
 void addText(TextPosition text)
          Adds a text position to the contents.
 void addXObject(PDXObject xobject)
          Adds an XObject to the contents.
static PDMarkedContent create(COSName tag, COSDictionary properties)
          Creates a marked-content sequence.
 java.lang.String getActualText()
          Gets the actual text (ActualText).
 java.lang.String getAlternateDescription()
          Gets the alternate description (Alt).
 java.util.List<java.lang.Object> getContents()
          Gets the contents of the marked content sequence.
 java.lang.String getExpandedForm()
          Gets the expanded form (E).
 java.lang.String getLanguage()
          Gets the language (Lang).
 int getMCID()
          Gets the marked-content identifier.
 COSDictionary getProperties()
          Gets the properties.
 java.lang.String getTag()
          Gets the tag.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PDMarkedContent

public PDMarkedContent(COSName tag,
                       COSDictionary properties)
Creates a new marked content object.

Parameters:
tag - the tag
properties - the properties
Method Detail

create

public static PDMarkedContent create(COSName tag,
                                     COSDictionary properties)
Creates a marked-content sequence.

Parameters:
tag - the tag
properties - the properties
Returns:
the marked-content sequence

getTag

public java.lang.String getTag()
Gets the tag.

Returns:
the tag

getProperties

public COSDictionary getProperties()
Gets the properties.

Returns:
the properties

getMCID

public int getMCID()
Gets the marked-content identifier.

Returns:
the marked-content identifier

getLanguage

public java.lang.String getLanguage()
Gets the language (Lang).

Returns:
the language

getActualText

public java.lang.String getActualText()
Gets the actual text (ActualText).

Returns:
the actual text

getAlternateDescription

public java.lang.String getAlternateDescription()
Gets the alternate description (Alt).

Returns:
the alternate description

getExpandedForm

public java.lang.String getExpandedForm()
Gets the expanded form (E).

Returns:
the expanded form

getContents

public java.util.List<java.lang.Object> getContents()
Gets the contents of the marked content sequence. Can be

Returns:
the contents of the marked content sequence

addText

public void addText(TextPosition text)
Adds a text position to the contents.

Parameters:
text - the text position

addMarkedContent

public void addMarkedContent(PDMarkedContent markedContent)
Adds a marked content to the contents.

Parameters:
markedContent - the marked content

addXObject

public void addXObject(PDXObject xobject)
Adds an XObject to the contents.

Parameters:
xobject - the XObject

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object