ImageGear for Java
ImGearDocumentPageArray Class Members
Methods 

The following tables list the members exposed by ImGearDocumentPageArray.

Public Methods
 NameDescription
Public MethodaddOverloaded. Adds a new ImGearPage to the end of the array of pages.  
Public MethodaddAllOverloaded. Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator (optional operation). The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)  
Public MethodclearRemoves all of the elements from this list (optional operation). The list will be empty after this call returns.  
Public MethodclonePerforms a deep copy of the page array (i.e., clones the pages as well.).  
Public MethodcontainsReturns true if this list contains the specified element. More formally, returns true if and only if this list contains at least one element e such that (o==null ? e==null : o.equals(e)).  
Public MethodcontainsAllReturns true if this list contains all of the elements of the specified collection.  
Public MethodgetGets the page at the specified index.  
Public MethodindexOfReturns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the lowest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.  
Public MethodisEmptyReturns true if this list contains no elements.  
Public MethoditeratorReturns an iterator over the elements in this list in proper sequence.  
Public MethodlastIndexOfReturns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the highest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.  
Public MethodlistIteratorOverloaded. Returns a list iterator over the elements in this list (in proper sequence).  
Public MethodremoveOverloaded. Removes the first occurrence of the specified element from this list, if it is present (optional operation). If this list does not contain the element, it is unchanged. More formally, removes the element with the lowest index i such that (o==null ? get(i)==null : o.equals(get(i))) (if such an element exists). Returns true if this list contained the specified element (or equivalently, if this list changed as a result of the call).  
Public MethodremoveAllRemoves from this list all of its elements that are contained in the specified collection (optional operation).  
Public MethodretainAllRetains only the elements in this list that are contained in the specified collection (optional operation). In other words, removes from this list all the elements that are not contained in the specified collection.  
Public MethodsetSets the page at the specified index.  
Public MethodsizeReturns the number of elements in this list. If this list contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.  
Public MethodsubListReturns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive. (If fromIndex and toIndex are equal, the returned list is empty.) The returned list is backed by this list, so non-structural changes in the returned list are reflected in this list, and vice-versa. The returned list supports all of the optional list operations supported by this list.

This method eliminates the need for explicit range operations (of the sort that commonly exist for arrays). Any operation that expects a list can be used as a range operation by passing a subList view instead of a whole list. For example, the following idiom removes a range of elements from a list:

 list.subList(from, to).clear(); 
Similar idioms may be constructed for indexOf and lastIndexOf, and all of the algorithms in the Collections class can be applied to a subList.

The semantics of the list returned by this method become undefined if the backing list (i.e., this list) is structurally modified in any way other than via the returned list. (Structural modifications are those that change the size of this list, or otherwise perturb it in such a fashion that iterations in progress may yield incorrect results.)

 
Public MethodtoArrayOverloaded. Returns an array containing all of the elements in this list in proper sequence (from first to last element).

The returned array will be "safe" in that no references to it are maintained by this list. (In other words, this method must allocate a new array even if this list is backed by an array). The caller is thus free to modify the returned array.

This method acts as bridge between array-based and collection-based APIs.

 
Top
See Also

Reference

ImGearDocumentPageArray Class
com.accusoft.imagegear.core Package

 

 


©2016. Accusoft Corporation. All Rights Reserved.

Send Feedback