com.aspose.gridweb

Class CustomCommandButtonCollection

java.lang.Object

com.aspose.gridweb.CollectionBase

com.aspose.gridweb.CustomCommandButtonCollection

All Implemented Interfaces:

java.lang.Iterable

public class CustomCommandButtonCollection
extends CollectionBase

Represents the collection of CustomCommandButton.

Example

 
         GridWeb GridWeb1 = new GridWeb();
         CustomCommandButton button = new CustomCommandButton();
         button.setCommand("MyCommand");
         button.setImageUrl("images/button1.gif");
         GridWeb1.getCustomCommandButtons().add(button);
 

Method Summary

Methods

Modifier and Type	Method and Description
int	add(java.lang.Object value) Add a custom command button object to the collection.
void	clear() Clears the collection.
boolean	contains(java.lang.Object value) Indicates whether the custom command button object is in the collection.
void	copyTo(java.lang.Object[] array, int index) Copies the collection to an array.
CustomCommandButton	get(int index) Gets a custom command button object at the index.
int	getCount() Gets the count of the collection.
java.lang.Object	getSyncRoot() Internal used only.
int	indexOf(java.lang.Object value) Gets the index of the button.
void	insert(int index, java.lang.Object value) Inserts a button at the index.
boolean	isFixedSize() Internal used only.
boolean	isReadOnly() Internal used only.
boolean	isSynchronized() Internal used only.
java.util.Iterator	iterator() Gets a IEnumerator object of the collection.
void	remove(java.lang.Object value) Removes the custom command button object.
void	removeAt(int index) Removes at the index.
void	set(int index, CustomCommandButton value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

get

public CustomCommandButton get(int index)

Gets a custom command button object at the index.

Overrides:

get in class CollectionBase

Parameters:

index - Specified position index.

Returns:

The item at specified position.

set

public void set(int index,
       CustomCommandButton value)

removeAt

public void removeAt(int index)

Removes at the index.

Overrides:

removeAt in class CollectionBase

Parameters:

index - Index.

insert

public void insert(int index,
          java.lang.Object value)

Inserts a button at the index.

Parameters:

index - Index.

value - The CustomCommandButton object.

remove

public void remove(java.lang.Object value)

Removes the custom command button object.

Parameters:

value - The custom command button object.

contains

public boolean contains(java.lang.Object value)

Indicates whether the custom command button object is in the collection.

Overrides:

contains in class CollectionBase

Parameters:

value - Indicates whether the custom command button object is in the collection.

Returns:

True of false.

clear

public void clear()

Clears the collection.

Overrides:

clear in class CollectionBase

indexOf

public int indexOf(java.lang.Object value)

Gets the index of the button.

Overrides:

indexOf in class CollectionBase

Parameters:

value - The button object.

Returns:

The index.

add

public int add(java.lang.Object value)

Add a custom command button object to the collection.

Overrides:

add in class CollectionBase

Parameters:

value - The custom command button object.

Returns:

The index.

isReadOnly

public boolean isReadOnly()

Internal used only.

isFixedSize

public boolean isFixedSize()

Internal used only.

copyTo

public void copyTo(java.lang.Object[] array,
          int index)

Copies the collection to an array.

Parameters:

array - The array.

index - The start index of the array.

isSynchronized

public boolean isSynchronized()

Internal used only.

getCount

public int getCount()

Gets the count of the collection.

Overrides:

getCount in class CollectionBase

Returns:

The number of elements contained in the CollectionBase instance.

getSyncRoot

public java.lang.Object getSyncRoot()

Internal used only.

iterator

public java.util.Iterator iterator()

Gets a IEnumerator object of the collection.

Specified by:

iterator in interface java.lang.Iterable

Overrides:

iterator in class CollectionBase

Returns:

The IEnumerator object.