Element

Inheritance: java.lang.Object

public abstract class Element

Class representing base element of logical structure.

Methods

MethodDescription
getChildren()Gets child elements collection.
getLang()(Optional; PDF 1.4) A language specifying the natural language for all text in the structure element except where overridden by language specifications for nested structure elements or marked content.
setLang(String value)(Optional; PDF 1.4) A language specifying the natural language for all text in the structure element except where overridden by language specifications for nested structure elements or marked content.
getActualText()(Optional; PDF 1.4) Text that is an exact replacement for the structure element and its children.
setActualText(String value)(Optional; PDF 1.4) Text that is an exact replacement for the structure element and its children.
getAlt()(Optional) An alternate description of the structure element and its children in human-readableform, which is useful when extracting the document\u2019s contents in support of accessibility to users with disabilities or for other purposes.
setAlt(String value)(Optional) An alternate description of the structure element and its children in human-readableform, which is useful when extracting the document\u2019s contents in support of accessibility to users with disabilities or for other purposes.
getE()(Optional; PDF 1.5) The expanded form of an abbreviation.
setE(String value)(Optional; PDF 1.5) The expanded form of an abbreviation.
remove()Remove element.

getChildren()

public final ElementCollection getChildren()

Gets child elements collection.

Returns: ElementCollection - ElementCollection instance

getLang()

public String getLang()

(Optional; PDF 1.4) A language specifying the natural language for all text in the structure element except where overridden by language specifications for nested structure elements or marked content.

Returns: java.lang.String - String object

setLang(String value)

public void setLang(String value)

(Optional; PDF 1.4) A language specifying the natural language for all text in the structure element except where overridden by language specifications for nested structure elements or marked content.

Parameters:

ParameterTypeDescription
valuejava.lang.StringString object

getActualText()

public String getActualText()

(Optional; PDF 1.4) Text that is an exact replacement for the structure element and its children. This replacement text (which should apply to as small a piece of content as possible) is useful when extracting the document\u2019s contents in support of accessibility to users with disabilities or for other purposes.

Returns: java.lang.String - String object

setActualText(String value)

public void setActualText(String value)

(Optional; PDF 1.4) Text that is an exact replacement for the structure element and its children. This replacement text (which should apply to as small a piece of content as possible) is useful when extracting the document\u2019s contents in support of accessibility to users with disabilities or for other purposes.

Parameters:

ParameterTypeDescription
valuejava.lang.StringString object

getAlt()

public String getAlt()

(Optional) An alternate description of the structure element and its children in human-readableform, which is useful when extracting the document\u2019s contents in support of accessibility to users with disabilities or for other purposes.

Returns: java.lang.String - String object

setAlt(String value)

public void setAlt(String value)

(Optional) An alternate description of the structure element and its children in human-readableform, which is useful when extracting the document\u2019s contents in support of accessibility to users with disabilities or for other purposes.

Parameters:

ParameterTypeDescription
valuejava.lang.StringString object

getE()

public String getE()

(Optional; PDF 1.5) The expanded form of an abbreviation.

Returns: java.lang.String - String object

setE(String value)

public void setE(String value)

(Optional; PDF 1.5) The expanded form of an abbreviation.

Parameters:

ParameterTypeDescription
valuejava.lang.StringString object

remove()

public final void remove()

Remove element.