com.aspose.pdf

Interfaces

Classes

Enums

Exceptions

com.aspose.pdf

Class AppearanceDictionary

  • All Implemented Interfaces:
    com.aspose.ms.System.Collections.Generic.IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XForm>>, com.aspose.ms.System.Collections.Generic.IGenericDictionary<String,XForm>, com.aspose.ms.System.Collections.Generic.IGenericEnumerable<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XForm>>, com.aspose.ms.System.Collections.IEnumerable<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XForm>>, Iterable<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XForm>>


    public final class AppearanceDictionary
    extends Object
    implements com.aspose.ms.System.Collections.Generic.IGenericDictionary<String,XForm>

    Annotation appearance dictionary specifying how the annotation shall be presented visually on the page.

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method and Description
      void add(Object key, Object value)
      Deprecated. 
      void addItem(com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XForm> item)
      Adds pair with key and value into the dictionary.
      void addItem(String key, XForm value)
      Add X form for specifed key.
      void clear()
      Removes all elements from the dictionary.
      boolean contains(Object key)
      Deprecated. 
      boolean containsItem(com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XForm> item)
      Checks does specified key-value pair is contained in the dictionary.
      boolean containsKey(String key)
      Determines does this dictionary contasins specified key.
      void copyTo(com.aspose.ms.System.Array array, int index)
      Copies the elements of the dictionary to an Array, starting at a particular Array index.
      void copyToTArray(com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XForm>[] array, int arrayIndex)
      Copies the elements of the ICollection to an Array, starting at a particular Array index.
      XForm get_Item(String key)
      Represents convenient form for getting appearance streams.
      XForm get(Object key)
      Deprecated. 
      com.aspose.pdf.engine.data.IPdfDictionary getDict()
      Gets pdf dictionary
      List<String> getKeys_()
      Gets keys of the dictionary.
      com.aspose.ms.System.Collections.Generic.List<String> getKeys()
      Gets keys of the dictionary.
      Object getSyncRoot()
      Gets an object that can be used to synchronize access to the dictionary.
      List<XForm> getValues_()
      Gets the list of the dictionary values.
      com.aspose.ms.System.Collections.Generic.IGenericCollection<XForm> getValues_Rename_Namesake()
      Gets collection of values in the dictionary.
      com.aspose.ms.System.Collections.Generic.List<XForm> getValues()
      Gets the list of the dictionary values.
      boolean isFixedSize()
      Gets a value indicating whether dictionary has a fixed size.
      boolean isReadOnly()
      Gets a value indicating whether dictionary is read-only.
      boolean isSynchronized()
      Gets a value indicating whether access to the dictionary is synchronized (thread safe).
      com.aspose.ms.System.Collections.Generic.IGenericEnumerator<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,com.aspose.pdf.engine.data.IPdfPrimitive>> iterator__Rename_Namesake()
      Enumerator for the collection.
      com.aspose.pdf.AppearanceDictionary.AppearanceDictionaryEnumerator iterator_internal()
      Returns an IDictionaryEnumerator object for the dictionary.
      com.aspose.ms.System.Collections.IEnumerator iterator_Rename_Namesake()
      For internal usage only Enumerator of the key items.
      com.aspose.ms.System.Collections.Generic.IGenericEnumerator<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XForm>> iterator()
      Returns an IDictionaryEnumerator object for the dictionary.
      boolean removeItem(com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XForm> item)
      Removes key/value pair from the collection.
      boolean removeItemByKey(String key)
      Removes key from the dictionary.
      void removeItemInternal(Object key)
      Deprecated. 
      void set_Item(String key, XForm value) 
      void set(Object key, XForm value)
      Deprecated. 
      int size()
      Gets the number of elements contained in the dictionary.
      boolean tryGetValue(String key, Object[] value)
      Tries to find key in the dictionary and retreives value if found.
    • Method Detail

      • getDict

        public com.aspose.pdf.engine.data.IPdfDictionary getDict()

        Gets pdf dictionary

        Returns:
        IPdfDictionary object
      • isReadOnly

        public boolean isReadOnly()

        Gets a value indicating whether dictionary is read-only.

        Specified by:
        isReadOnly in interface com.aspose.ms.System.Collections.Generic.IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XForm>>
        Returns:
        boolean value
      • isFixedSize

        public boolean isFixedSize()

        Gets a value indicating whether dictionary has a fixed size.

        Returns:
        boolean value
      • getKeys

        public com.aspose.ms.System.Collections.Generic.List<String> getKeys()

        Gets keys of the dictionary. If appearance dictionary has subditionaries, then Keys contains (N|R|D).state values, where N - normal appearance, R - rollover appearance, D - down appearance and state - the name of the state (e.g. On, Off for checkboxes).

        Specified by:
        getKeys in interface com.aspose.ms.System.Collections.Generic.IGenericDictionary<String,XForm>
        Returns:
        List of String values
      • getKeys_

        public List<String> getKeys_()

        Gets keys of the dictionary. If appearance dictionary has subditionaries, then Keys contains (N|R|D).state values, where N - normal appearance, R - rollover appearance, D - down appearance and state - the name of the state (e.g. On, Off for checkboxes).

        Returns:
        List of String values
      • getValues

        public com.aspose.ms.System.Collections.Generic.List<XForm> getValues()

        Gets the list of the dictionary values. Result collection contains the list of XForm objects.

        Specified by:
        getValues in interface com.aspose.ms.System.Collections.Generic.IGenericDictionary<String,XForm>
        Returns:
        List of XForm values
      • getValues_

        public List<XForm> getValues_()

        Gets the list of the dictionary values. Result collection contains the list of XForm objects.

        Returns:
        List of XForm values
      • isSynchronized

        public boolean isSynchronized()

        Gets a value indicating whether access to the dictionary is synchronized (thread safe).

        Returns:
        boolean value
      • getSyncRoot

        public Object getSyncRoot()

        Gets an object that can be used to synchronize access to the dictionary.

        Returns:
        Object for synchronization
      • size

        public int size()

        Gets the number of elements contained in the dictionary.

        Specified by:
        size in interface com.aspose.ms.System.Collections.Generic.IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XForm>>
        Returns:
        int value
      • contains

        @Deprecated
        public boolean contains(Object key)
        Deprecated. 

        Determines whether dictionary contains an element with the specified key.

        Parameters:
        key - Key to test does it belongs to dictionary.
        Returns:
        true if the key found in the dictionary and false otherwise.
      • removeItemInternal

        @Deprecated
        public void removeItemInternal(Object key)
        Deprecated. 

        Removes the element with the specified key.

        Parameters:
        key - Key which should be deleted.
      • clear

        public void clear()

        Removes all elements from the dictionary.

        Specified by:
        clear in interface com.aspose.ms.System.Collections.Generic.IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XForm>>
      • add

        @Deprecated
        public void add(Object key,
                                     Object value)
        Deprecated. 

        Adds an element with the provided key and value.

        Parameters:
        key - Element key.
        value - Element value.
      • iterator

        public com.aspose.ms.System.Collections.Generic.IGenericEnumerator<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XForm>> iterator()

        Returns an IDictionaryEnumerator object for the dictionary.

        Specified by:
        iterator in interface com.aspose.ms.System.Collections.Generic.IGenericEnumerable<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XForm>>
        Specified by:
        iterator in interface com.aspose.ms.System.Collections.IEnumerable<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XForm>>
        Specified by:
        iterator in interface Iterable<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XForm>>
        Returns:
        Enumerator of the dictionary.
      • iterator_internal

        public com.aspose.pdf.AppearanceDictionary.AppearanceDictionaryEnumerator iterator_internal()

        Returns an IDictionaryEnumerator object for the dictionary.

        Returns:
        Enumerator of the dictionary.
      • copyTo

        public void copyTo(com.aspose.ms.System.Array array,
                           int index)

        Copies the elements of the dictionary to an Array, starting at a particular Array index.

        Parameters:
        array - Array where items must be copied.
        index - Index where items must be copied.
      • get_Item

        public XForm get_Item(String key)

        Represents convenient form for getting appearance streams.

        Specified by:
        get_Item in interface com.aspose.ms.System.Collections.Generic.IGenericDictionary<String,XForm>
        Parameters:
        key - Represents path to appearance stream. If appearance dictionary has subdictionaries, then path must contain 2 parts (Keys), else path has only one part.
        Returns:
        XForm object (appearance stream) which corresponds to the given key.
      • set_Item

        public void set_Item(String key,
                             XForm value)
        Specified by:
        set_Item in interface com.aspose.ms.System.Collections.Generic.IGenericDictionary<String,XForm>
      • get

        @Deprecated
        public XForm get(Object key)
        Deprecated. 

        Represents convenient form for getting appearance streams.

        Parameters:
        key - Represents path to appearance stream. If appearance dictionary has subdictionaries, then path must contain 2 parts (Keys), else path has only one part.
        Returns:
        XForm object (appearance stream) which corresponds to the given key.
      • set

        @Deprecated
        public void set(Object key,
                                     XForm value)
        Deprecated. 

        Represents convenient form for setting appearance streams.

        Parameters:
        key - Represents path to appearance stream. If appearance dictionary has subdictionaries, then path must contain 2 parts (Keys), else path has only one part.
        value - XForm object (appearance stream) which corresponds to the given key.
      • iterator_Rename_Namesake

        public com.aspose.ms.System.Collections.IEnumerator iterator_Rename_Namesake()
        For internal usage only

        Enumerator of the key items.

        Returns:
        IEnumerator object
      • addItem

        public void addItem(String key,
                            XForm value)

        Add X form for specifed key.

        Specified by:
        addItem in interface com.aspose.ms.System.Collections.Generic.IGenericDictionary<String,XForm>
        Parameters:
        key - Element key.
        value - XForm object value.
      • containsKey

        public boolean containsKey(String key)

        Determines does this dictionary contasins specified key.

        Specified by:
        containsKey in interface com.aspose.ms.System.Collections.Generic.IGenericDictionary<String,XForm>
        Parameters:
        key - Key to search in the dictionary.
        Returns:
        true if key is found.
      • removeItemByKey

        public boolean removeItemByKey(String key)

        Removes key from the dictionary.

        Specified by:
        removeItemByKey in interface com.aspose.ms.System.Collections.Generic.IGenericDictionary<String,XForm>
        Parameters:
        key - Key to be removed from the dictionary.
        Returns:
        true if key was successfully removed.
      • tryGetValue

        public boolean tryGetValue(String key,
                                   Object[] value)

        Tries to find key in the dictionary and retreives value if found.

        Specified by:
        tryGetValue in interface com.aspose.ms.System.Collections.Generic.IGenericDictionary<String,XForm>
        Parameters:
        key - Key to search in the dictionary.
        value - Retreived value.
        Returns:
        true if key was found.
      • getValues_Rename_Namesake

        public com.aspose.ms.System.Collections.Generic.IGenericCollection<XForm> getValues_Rename_Namesake()

        Gets collection of values in the dictionary.

        Returns:
        IDictionary<String, XForm> object
      • addItem

        public void addItem(com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XForm> item)

        Adds pair with key and value into the dictionary.

        Specified by:
        addItem in interface com.aspose.ms.System.Collections.Generic.IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XForm>>
        Parameters:
        item - Item to be added.
      • containsItem

        public boolean containsItem(com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XForm> item)

        Checks does specified key-value pair is contained in the dictionary.

        Specified by:
        containsItem in interface com.aspose.ms.System.Collections.Generic.IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XForm>>
        Parameters:
        item - Key-value pair.
        Returns:
        true if this pauir was found.
      • copyToTArray

        public void copyToTArray(com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XForm>[] array,
                                 int arrayIndex)

        Copies the elements of the ICollection to an Array, starting at a particular Array index.

        Specified by:
        copyToTArray in interface com.aspose.ms.System.Collections.Generic.IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XForm>>
        Parameters:
        array - The one-dimensional Array that is the destination of the elements copied from ICollection. The Array must have zero-based indexing.
        arrayIndex - The zero-based index in array at which copying begins.
      • removeItem

        public boolean removeItem(com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XForm> item)

        Removes key/value pair from the collection.

        Specified by:
        removeItem in interface com.aspose.ms.System.Collections.Generic.IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,XForm>>
        Parameters:
        item - Key/value pair to be removed.
        Returns:
        true if pair was found and removed.
      • iterator__Rename_Namesake

        public com.aspose.ms.System.Collections.Generic.IGenericEnumerator<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,com.aspose.pdf.engine.data.IPdfPrimitive>> iterator__Rename_Namesake()

        Enumerator for the collection.

        Returns:
        enumerator of the collection items.