AppearanceDictionary

Inheritance: java.lang.Object

All Implemented Interfaces: com.aspose.ms.System.Collections.Generic.IGenericDictionary

public final class AppearanceDictionary implements System.Collections.Generic.IGenericDictionary<String,XForm>

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

Methods

MethodDescription
getDict()Gets pdf dictionary
isReadOnly()Gets a value indicating whether dictionary is read-only.
isFixedSize()Gets a value indicating whether dictionary has a fixed size.
getKeys()Gets keys of the dictionary.
getKeys_()Gets keys of the dictionary.
getValues()Gets the list of the dictionary values.
getValues_()Gets the list of the dictionary values.
isSynchronized()Gets a value indicating whether access to the dictionary is synchronized (thread safe).
getSyncRoot()Gets an object that can be used to synchronize access to the dictionary.
size()Gets the number of elements contained in the dictionary.
clear()Removes all elements from the dictionary.
add(Object key, Object value)Adds an element with the provided key and value.
iterator()Returns an IDictionaryEnumerator object for the dictionary.
copyTo(XForm[] array, int index)Copies the elements of the dictionary to an Array, starting at a particular Array index.
get_Item(String key)Represents convenient form for getting appearance streams.
set_Item(String key, XForm value)
addItem(String key, XForm value)Add X form for specifed key.
containsKey(String key)Determines does this dictionary contasins specified key.
removeItemByKey(String key)Removes key from the dictionary.
tryGetValue(String key, Object[] value)Tries to find key in the dictionary and retreives value if found.
addItem(System.Collections.Generic.KeyValuePair<String,XForm> item)Adds pair with key and value into the dictionary.
containsItem(System.Collections.Generic.KeyValuePair<String,XForm> item)Checks does specified key-value pair is contained in the dictionary.
copyToTArray(System.Collections.Generic.KeyValuePair<String,XForm>[] array, int arrayIndex)Copies the elements of the ICollection to an Array, starting at a particular Array index.
removeItem(System.Collections.Generic.KeyValuePair<String,XForm> item)Removes key/value pair from the collection.
iterator__Rename_Namesake()Enumerator for the collection.

getDict()

public IPdfDictionary getDict()

Gets pdf dictionary

Returns: IPdfDictionary - IPdfDictionary object

isReadOnly()

public boolean isReadOnly()

Gets a value indicating whether dictionary is read-only.

Returns: boolean - boolean value

isFixedSize()

public boolean isFixedSize()

Gets a value indicating whether dictionary has a fixed size.

Returns: boolean - boolean value

getKeys()

public System.Collections.Generic.IGenericCollection<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: com.aspose.ms.System.Collections.Generic.IGenericCollection<java.lang.String> - 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: java.util.List<java.lang.String> - List of String values

getValues()

public System.Collections.Generic.IGenericCollection<XForm> getValues()

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

Returns: com.aspose.ms.System.Collections.Generic.IGenericCollection<com.aspose.pdf.XForm> - 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: java.util.List<com.aspose.pdf.XForm> - List of XForm values

isSynchronized()

public boolean isSynchronized()

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

Returns: boolean - boolean value

getSyncRoot()

public Object getSyncRoot()

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

Returns: java.lang.Object - Object for synchronization

size()

public int size()

Gets the number of elements contained in the dictionary.

Returns: int - int value

clear()

public void clear()

Removes all elements from the dictionary.

add(Object key, Object value)

public void add(Object key, Object value)

Adds an element with the provided key and value.

Parameters:

ParameterTypeDescription
keyjava.lang.ObjectElement key.
valuejava.lang.ObjectElement value.

iterator()

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

Returns an IDictionaryEnumerator object for the dictionary.

Returns: com.aspose.ms.System.Collections.Generic.IGenericEnumerator<com.aspose.ms.System.Collections.Generic.KeyValuePair<java.lang.String,com.aspose.pdf.XForm» - Enumerator of the dictionary.

copyTo(XForm[] array, int index)

public void copyTo(XForm[] array, int index)

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

Parameters:

ParameterTypeDescription
arrayXForm[]Array where items must be copied.
indexintIndex where items must be copied.

get_Item(String key)

public XForm get_Item(String key)

Represents convenient form for getting appearance streams.

Parameters:

ParameterTypeDescription
keyjava.lang.StringRepresents path to appearance stream. If appearance dictionary has subdictionaries, then path must contain 2 parts ( Keys ), else path has only one part.

Returns: XForm - XForm object (appearance stream) which corresponds to the given key.

set_Item(String key, XForm value)

public void set_Item(String key, XForm value)

Parameters:

ParameterTypeDescription
keyjava.lang.String
valueXForm

addItem(String key, XForm value)

public void addItem(String key, XForm value)

Add X form for specifed key.

Parameters:

ParameterTypeDescription
keyjava.lang.StringElement key.
valueXFormXForm object value.

containsKey(String key)

public boolean containsKey(String key)

Determines does this dictionary contasins specified key.

Parameters:

ParameterTypeDescription
keyjava.lang.StringKey to search in the dictionary.

Returns: boolean - true if key is found.

removeItemByKey(String key)

public boolean removeItemByKey(String key)

Removes key from the dictionary.

Parameters:

ParameterTypeDescription
keyjava.lang.StringKey to be removed from the dictionary.

Returns: boolean - true if key was successfully removed.

tryGetValue(String key, Object[] value)

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

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

Parameters:

ParameterTypeDescription
keyjava.lang.StringKey to search in the dictionary.
valuejava.lang.Object[]Retreived value.

Returns: boolean - true if key was found.

addItem(System.Collections.Generic.KeyValuePair<String,XForm> item)

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

Adds pair with key and value into the dictionary.

Parameters:

ParameterTypeDescription
itemcom.aspose.ms.System.Collections.Generic.KeyValuePair<java.lang.String,com.aspose.pdf.XForm>Item to be added.

containsItem(System.Collections.Generic.KeyValuePair<String,XForm> item)

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

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

Parameters:

ParameterTypeDescription
itemcom.aspose.ms.System.Collections.Generic.KeyValuePair<java.lang.String,com.aspose.pdf.XForm>Key-value pair.

Returns: boolean - true if this pauir was found.

copyToTArray(System.Collections.Generic.KeyValuePair<String,XForm>[] array, int arrayIndex)

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

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

Parameters:

ParameterTypeDescription
arraycom.aspose.ms.System.Collections.Generic.KeyValuePair<java.lang.String,com.aspose.pdf.XForm>[]The one-dimensional Array that is the destination of the elements copied from ICollection. The Array must have zero-based indexing.
arrayIndexintThe zero-based index in array at which copying begins.

removeItem(System.Collections.Generic.KeyValuePair<String,XForm> item)

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

Removes key/value pair from the collection.

Parameters:

ParameterTypeDescription
itemcom.aspose.ms.System.Collections.Generic.KeyValuePair<java.lang.String,com.aspose.pdf.XForm>Key/value pair to be removed.

Returns: boolean - true if pair was found and removed.

iterator__Rename_Namesake()

public System.Collections.Generic.IGenericEnumerator<System.Collections.Generic.KeyValuePair<String,XForm>> iterator__Rename_Namesake()

Enumerator for the collection.

Returns: com.aspose.ms.System.Collections.Generic.IGenericEnumerator<com.aspose.ms.System.Collections.Generic.KeyValuePair<java.lang.String,com.aspose.pdf.XForm» - enumerator of the collection items.