Package com.tom_roush.pdfbox.pdmodel.documentinterchange.taggedpdf

Class PDStandardAttributeObject

    • 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​(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 String getString​(String name)
        Gets a string attribute value.
        Parameters:
        name - the attribute name
        Returns:
        the string attribute value

      • setString

        protected void setString​(String name,
                         String value)
        Sets a string attribute value.
        Parameters:
        name - the attribute name
        value - the string attribute value

      • getArrayOfString

        protected String[] getArrayOfString​(String name)
        Gets an array of strings.
        Parameters:
        name - the attribute name
        Returns:
        the array of strings

      • setArrayOfString

        protected void setArrayOfString​(String name,
                                String[] values)
        Sets an array of strings.
        Parameters:
        name - the attribute name
        values - the array of strings

      • getName

        protected String getName​(String name)
        Gets a name value.
        Parameters:
        name - the attribute name
        Returns:
        the name value

      • getName

        protected String getName​(String name,
                         String defaultValue)
        Gets a name value.
        Parameters:
        name - the attribute name
        defaultValue - the default value
        Returns:
        the name value

      • getNameOrArrayOfName

        protected Object getNameOrArrayOfName​(String name,
                                      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​(String name,
                       String value)
        Sets a name value.
        Parameters:
        name - the attribute name
        value - the name value

      • setArrayOfName

        protected void setArrayOfName​(String name,
                              String[] values)
        Sets an array of name values.
        Parameters:
        name - the attribute name
        values - the array of name values

      • getNumberOrName

        protected Object getNumberOrName​(String name,
                                 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​(String name,
                         int defaultValue)
        Gets an integer.
        Parameters:
        name - the attribute name
        defaultValue - the default value
        Returns:
        the integer

      • setInteger

        protected void setInteger​(String name,
                          int value)
        Sets an integer.
        Parameters:
        name - the attribute name
        value - the integer

      • getNumber

        protected float getNumber​(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​(String name)
        Gets a number value.
        Parameters:
        name - the attribute name
        Returns:
        the number value

      • getNumberOrArrayOfNumber

        protected Object getNumberOrArrayOfNumber​(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​(String name,
                         float value)
        Sets a float number.
        Parameters:
        name - the attribute name
        value - the float number

      • setNumber

        protected void setNumber​(String name,
                         int value)
        Sets an integer number.
        Parameters:
        name - the attribute name
        value - the integer number

      • setArrayOfNumber

        protected void setArrayOfNumber​(String name,
                                float[] values)
        Sets an array of float numbers.
        Parameters:
        name - the attribute name
        values - the float numbers

      • getColor

        protected PDGamma getColor​(String name)
        Gets a colour.
        Parameters:
        name - the attribute name
        Returns:
        the colour

      • getColorOrFourColors

        protected Object getColorOrFourColors​(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​(String name,
                        PDGamma value)
        Sets a colour.
        Parameters:
        name - the attribute name
        value - the colour

      • setFourColors

        protected void setFourColors​(String name,
                             PDFourColours value)
        Sets four colours.
        Parameters:
        name - the attribute name
        value - the four colours