Package org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf

Class PDStandardAttributeObject

java.lang.Object

org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper

org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject

org.apache.pdfbox.pdmodel.documentinterchange.taggedpdf.PDStandardAttributeObject

All Implemented Interfaces:

COSObjectable

Direct Known Subclasses:

PDLayoutAttributeObject, PDListAttributeObject, PDPrintFieldAttributeObject, PDTableAttributeObject

public abstract class PDStandardAttributeObject
extends PDAttributeObject

A standard attribute object.

Author:

Johannes Koch

Field Summary

Fields

Modifier and Type	Field	Description
protected static float	UNSPECIFIED	An "unspecified" default float value.

Constructor Summary

Constructors

Constructor	Description
PDStandardAttributeObject()	Default constructor.
PDStandardAttributeObject(COSDictionary dictionary)	Creates a new standard attribute object with a given dictionary.

Method Summary

Modifier and Type	Method	Description
protected java.lang.String[]	getArrayOfString(java.lang.String name)	Gets an array of strings.
protected PDGamma	getColor(java.lang.String name)	Gets a colour.
protected java.lang.Object	getColorOrFourColors(java.lang.String name)	Gets a single colour or four colours.
protected int	getInteger(java.lang.String name, int defaultValue)	Gets an integer.
protected java.lang.String	getName(java.lang.String name)	Gets a name value.
protected java.lang.String	getName(java.lang.String name, java.lang.String defaultValue)	Gets a name value.
protected java.lang.Object	getNameOrArrayOfName(java.lang.String name, java.lang.String defaultValue)	Gets a name value or array of name values.
protected float	getNumber(java.lang.String name)	Gets a number value.
protected float	getNumber(java.lang.String name, float defaultValue)	Gets a number value.
protected java.lang.Object	getNumberOrArrayOfNumber(java.lang.String name, float defaultValue)	Gets a number or an array of numbers.
protected java.lang.Object	getNumberOrName(java.lang.String name, java.lang.String defaultValue)	Gets a number or a name value.
protected java.lang.String	getString(java.lang.String name)	Gets a string attribute value.
boolean	isSpecified(java.lang.String name)	Is the attribute with the given name specified in this attribute object?
protected void	setArrayOfName(java.lang.String name, java.lang.String[] values)	Sets an array of name values.
protected void	setArrayOfNumber(java.lang.String name, float[] values)	Sets an array of float numbers.
protected void	setArrayOfString(java.lang.String name, java.lang.String[] values)	Sets an array of strings.
protected void	setColor(java.lang.String name, PDGamma value)	Sets a colour.
protected void	setFourColors(java.lang.String name, PDFourColours value)	Sets four colours.
protected void	setInteger(java.lang.String name, int value)	Sets an integer.
protected void	setName(java.lang.String name, java.lang.String value)	Sets a name value.
protected void	setNumber(java.lang.String name, float value)	Sets a float number.
protected void	setNumber(java.lang.String name, int value)	Sets an integer number.
protected void	setString(java.lang.String name, java.lang.String value)	Sets a string attribute value.

Methods inherited from class org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDAttributeObject

arrayToString, arrayToString, create, getOwner, isEmpty, notifyChanged, potentiallyNotifyChanged, setOwner, setStructureElement, toString

Methods inherited from class org.apache.pdfbox.pdmodel.common.PDDictionaryWrapper

equals, getCOSObject, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

UNSPECIFIED

protected static final float UNSPECIFIED

An "unspecified" default float value.

See Also:

Constant Field Values

Constructor Detail

PDStandardAttributeObject

public PDStandardAttributeObject()

Default constructor.

PDStandardAttributeObject

public PDStandardAttributeObject(COSDictionary dictionary)

Creates a new standard attribute object with a given dictionary.

Parameters:

dictionary - the dictionary

Method Detail

isSpecified

public boolean isSpecified(java.lang.String name)

Is the attribute with the given name specified in this attribute object?

Parameters:

name - the attribute name

Returns:

true if the attribute is specified, false otherwise

getString

protected java.lang.String getString(java.lang.String name)

Gets a string attribute value.

Parameters:

name - the attribute name

Returns:

the string attribute value

setString

protected void setString(java.lang.String name,
                         java.lang.String value)

Sets a string attribute value.

Parameters:

name - the attribute name

value - the string attribute value

getArrayOfString

protected java.lang.String[] getArrayOfString(java.lang.String name)

Gets an array of strings.

Parameters:

name - the attribute name

Returns:

the array of strings

setArrayOfString

protected void setArrayOfString(java.lang.String name,
                                java.lang.String[] values)

Sets an array of strings.

Parameters:

name - the attribute name

values - the array of strings

getName

protected java.lang.String getName(java.lang.String name)

Gets a name value.

Parameters:

name - the attribute name

Returns:

the name value

getName

protected java.lang.String getName(java.lang.String name,
                                   java.lang.String defaultValue)

Gets a name value.

Parameters:

name - the attribute name

defaultValue - the default value

Returns:

the name value

getNameOrArrayOfName

protected java.lang.Object getNameOrArrayOfName(java.lang.String name,
                                                java.lang.String defaultValue)

Gets a name value or array of name values.

Parameters:

name - the attribute name

defaultValue - the default value

Returns:

a String or array of Strings

setName

protected void setName(java.lang.String name,
                       java.lang.String value)

Sets a name value.

Parameters:

name - the attribute name

value - the name value

setArrayOfName

protected void setArrayOfName(java.lang.String name,
                              java.lang.String[] values)

Sets an array of name values.

Parameters:

name - the attribute name

values - the array of name values

getNumberOrName

protected java.lang.Object getNumberOrName(java.lang.String name,
                                           java.lang.String defaultValue)

Gets a number or a name value.

Parameters:

name - the attribute name

defaultValue - the default name

Returns:

a Float or a String

getInteger

protected int getInteger(java.lang.String name,
                         int defaultValue)

Gets an integer.

Parameters:

name - the attribute name

defaultValue - the default value

Returns:

the integer

setInteger

protected void setInteger(java.lang.String name,
                          int value)

Sets an integer.

Parameters:

name - the attribute name

value - the integer

getNumber

protected float getNumber(java.lang.String name,
                          float defaultValue)

Gets a number value.

Parameters:

name - the attribute name

defaultValue - the default value

Returns:

the number value

getNumber

protected float getNumber(java.lang.String name)

Gets a number value.

Parameters:

name - the attribute name

Returns:

the number value

getNumberOrArrayOfNumber

protected java.lang.Object getNumberOrArrayOfNumber(java.lang.String name,
                                                    float defaultValue)

Gets a number or an array of numbers.

Parameters:

name - the attribute name

defaultValue - the default value

Returns:

a Float or an array of floats

setNumber

protected void setNumber(java.lang.String name,
                         float value)

Sets a float number.

Parameters:

name - the attribute name

value - the float number

setNumber

protected void setNumber(java.lang.String name,
                         int value)

Sets an integer number.

Parameters:

name - the attribute name

value - the integer number

setArrayOfNumber

protected void setArrayOfNumber(java.lang.String name,
                                float[] values)

Sets an array of float numbers.

Parameters:

name - the attribute name

values - the float numbers

getColor

protected PDGamma getColor(java.lang.String name)

Gets a colour.

Parameters:

name - the attribute name

Returns:

the colour

getColorOrFourColors

protected java.lang.Object getColorOrFourColors(java.lang.String name)

Gets a single colour or four colours.

Parameters:

name - the attribute name

Returns:

the single (PDGamma) or a (PDFourColours)

setColor

protected void setColor(java.lang.String name,
                        PDGamma value)

Sets a colour.

Parameters:

name - the attribute name

value - the colour

setFourColors

protected void setFourColors(java.lang.String name,
                             PDFourColours value)

Sets four colours.

Parameters:

name - the attribute name

value - the four colours