XImageCollection
Inheritance: java.lang.Object, com.aspose.pdf.XImageCollection
All Implemented Interfaces: Iterable < XImage >
public final class XImageCollection extends Object implements Iterable < XImage >
Class representing XImage collection.
Methods
| Method | Description |
|---|---|
| add | Adds entity to the end of the collection, so entity can be accessed by the last index. |
| add | Adds entity to the end of the collection, so entity can be accessed by the last index. |
| add | Adds entity to the end of the collection, so entity can be accessed by the last index. |
| add | Adds entity to the end of the collection, so entity can be accessed by the last index. |
| add | Adds entity to the end of the collection, so entity can be accessed by the last index. |
| add | Adds entity to the end of the collection, so entity can be accessed by the last index. |
| add | Adds entity to the end of the collection, so entity can be accessed by the last index. |
| add | Adds new image to Image list. This method adds image as reference to the same PdfObject (which allows to decrease file size) |
| add | |
| addWithImageFilterType | Adds entity to the end of the collection, so entity can be accessed by the last index. |
| clear | Clears all items from the collection. |
| contains | Determines whether the collection contains a specific value. |
| copyTo | Copies array of images into collection. |
| delete | Deletes images from collection. |
| delete | Removes index from collection by index. |
| delete | Removes index from collection by index performing action specified by action parameter. |
| delete | Deletes images from collection. |
| delete | Deletes images from collection. |
| get_Item | Gets image from collection by its index. |
| get_Item | Gets image from collection by its name. |
| getImageName | Returns name in images list which is key of the given image. |
| getNames | Gets array of image names. |
| getSyncRoot | Returns synchronization object. |
| hasImage | |
| isReadOnly | Gets a value indicating whether the collection is read-only. |
| isSynchronized | Returns true if object is synchronized. |
| iterator | Returns collection enumerator. |
| remove | Not supported yet, throws exception. Always throws NotImplementedException |
| replace | Replace image in collection with another image. |
| replace | Replace image in collection with another image. |
| replace | Replace image in collection with another image. |
| saveJpxWithQuality | |
| size | Count of images in collection. |
add
Adds entity to the end of the collection, so entity can be accessed by the last index.
add
Adds entity to the end of the collection, so entity can be accessed by the last index.
add
Adds entity to the end of the collection, so entity can be accessed by the last index.
add
Adds entity to the end of the collection, so entity can be accessed by the last index.
add
Adds entity to the end of the collection, so entity can be accessed by the last index.
add
Adds entity to the end of the collection, so entity can be accessed by the last index.
add
Adds entity to the end of the collection, so entity can be accessed by the last index.
add
Adds new image to Image list. This method adds image as reference to the same PdfObject (which allows to decrease file size)
add
addWithImageFilterType
Adds entity to the end of the collection, so entity can be accessed by the last index.
clear
public void clear()
Clears all items from the collection.
contains
Determines whether the collection contains a specific value.
copyTo
Copies array of images into collection.
delete
public void delete()
Deletes images from collection.
delete
public void delete(int index)
Removes index from collection by index.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | Image index. |
delete
public final void delete(int index, int action)
Removes index from collection by index performing action specified by action parameter.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | Index of the image to be removed. | |
| action | ImageDeleteAction element. Action performed after image deleting. |
delete
Deletes images from collection.
delete
Deletes images from collection.
get_Item
public XImage get_Item(int index)
Gets image from collection by its index.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | Image index |
Returns: Retrieved image.
get_Item
Gets image from collection by its name.
getImageName
Returns name in images list which is key of the given image.
getNames
public String [] getNames()
Gets array of image names.
Returns: String[] array
getSyncRoot
public Object getSyncRoot()
Returns synchronization object.
Returns: Object element
hasImage
isReadOnly
public boolean isReadOnly()
Gets a value indicating whether the collection is read-only.
Returns: boolean value
isSynchronized
public boolean isSynchronized()
Returns true if object is synchronized.
Returns: boolean value
iterator
public Iterator < XImage > iterator()
Returns collection enumerator.
Returns: Enumerator of collection
remove
Not supported yet, throws exception. Always throws NotImplementedException
replace
Replace image in collection with another image.
replace
Replace image in collection with another image.
replace
Replace image in collection with another image.
saveJpxWithQuality
size
public int size()
Count of images in collection.
Returns: int value