com.softwarefx.chartfx.server
Class CommandCollection

java.lang.Object
  com.softwarefx.chartfx.server.CommandCollection

All Implemented Interfaces:

Iterable<Command>, Collection<Command>

public class CommandCollection
extends Object
implements Iterable<Command>, Collection<Command>

Provides access to the CommandCollection object.

Constructor Summary

CommandCollection()

Method Summary

boolean	add(Command o) Appends the specified element to the CommandCollection collection.
boolean	addAll(Collection<? extends Command> c) Adds all of the elements in the specified collection to the CommandCollection collection.
void	addRange(Command[] items) Adds an array of objects to the CommandCollection collection.
int	appendImage(Image image) Appends the specified image to the CommandCollection.
void	clear() Removes all of the elements from this collection.
boolean	contains(Object o) Returns true if the CommandCollection contains the specified element.
boolean	containsAll(Collection<?> c) Returns true if the CommandCollection collection contains all of the elements in the specified collection.
void	copyTo(Command[] items, int index) Copies the entire Collection to a compatible one-dimensional Array, starting at the specified index of the target array.
void	dispose() Error: D:\Dev\CfxJava70\JavaDoc\docsource\\Objects\Collections\dispose.xml
Command	get(CommandId commandId) Returns the element at the specified position in the CommandCollection.
Command	get(int commandId) Returns the element at the specified position in the CommandCollection.
Font	getFont() Gets the Font.
Image	getImage() Gets Image associated with command in CommandCollection.
boolean	isEmpty() Returns true if this collection contains no elements.
Iterator<Command>	iterator() Returns an iterator over the elements in this collection.
boolean	remove(Object o) Removes the specified element from the CommandCollection collection.
boolean	removeAll(Collection<?> c) Removes all of the elements in the specified collection from the CommandCollection collection.
void	replaceImage(int index, Image image) Replaces an image in the CommandCollection.
boolean	retainAll(Collection<?> c) Retains only the elements in the CommandCollection collection that are contained in the specified collection.
void	setFont(Font value) Sets the font type which will be used by the commands.
int	size() Returns the number of elements in this collection.
Object[]	toArray() Returns an array containing all of the elements in this collection in proper sequence.
<T> T[]	toArray(T[] a) Returns an array containing all of the elements in this collection in proper sequence.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode

Constructor Detail

CommandCollection

public CommandCollection()

Method Detail

add

public boolean add(Command o)

Appends the specified element to the CommandCollection collection.

Specified by:

add in interface Collection<Command>

Parameters:

o - The item to add to the CommandCollection collection.

addAll

public boolean addAll(Collection<? extends Command> c)

Adds all of the elements in the specified collection to the CommandCollection collection.

Specified by:

addAll in interface Collection<Command>

Parameters:

c - Elements to be inserted into this collection.

addRange

public void addRange(Command[] items)

Adds an array of objects to the CommandCollection collection.

Parameters:

items - An array of objects to add to the collection.

appendImage

public int appendImage(Image image)

Appends the specified image to the CommandCollection. Returns the integer that should be used with the property ImageIndex of the CommandCollection Class.

Parameters:

image - The image to be added to the Collection.

clear

public void clear()

Removes all of the elements from this collection.

Specified by:

clear in interface Collection<Command>

contains

public boolean contains(Object o)

Returns true if the CommandCollection contains the specified element.

Specified by:

contains in interface Collection<Command>

Parameters:

o - Element whose presence in this collection is to be tested.

containsAll

public boolean containsAll(Collection<?> c)

Returns true if the CommandCollection collection contains all of the elements in the specified collection.

Specified by:

containsAll in interface Collection<Command>

Parameters:

c - Collection to be checked for containment in this collection.

copyTo

public void copyTo(Command[] items,
                   int index)

Copies the entire Collection to a compatible one-dimensional Array, starting at the specified index of the target array.

Parameters:

items - The one-dimensional Array that is the destination of the elements copied from CommandCollection. The Array must have zero-based indexing.

index - The zero-based index in array at which copying begins.

dispose

public void dispose()

Error: D:\Dev\CfxJava70\JavaDoc\docsource\\Objects\Collections\dispose.xml

ERROR: Root element is missing.

get

public Command get(CommandId commandId)

Returns the element at the specified position in the CommandCollection.

Parameters:

commandId - Index of element to return.

get

public Command get(int commandId)

Returns the element at the specified position in the CommandCollection.

Parameters:

commandId - Index of element to return.

getFont

public Font getFont()

Gets the Font. For more detail see setFont(java.awt.Font).

getImage

public Image getImage()

Gets Image associated with command in CommandCollection.

isEmpty

public boolean isEmpty()

Returns true if this collection contains no elements.

Specified by:

isEmpty in interface Collection<Command>

iterator

public Iterator<Command> iterator()

Returns an iterator over the elements in this collection.

Specified by:

iterator in interface Iterable<Command>

Specified by:

iterator in interface Collection<Command>

remove

public boolean remove(Object o)

Removes the specified element from the CommandCollection collection.

Specified by:

remove in interface Collection<Command>

Parameters:

o - The item to remove from the CommandCollection collection.

removeAll

public boolean removeAll(Collection<?> c)

Removes all of the elements in the specified collection from the CommandCollection collection.

Specified by:

removeAll in interface Collection<Command>

Parameters:

c - Elements to be removed from this collection.

replaceImage

public void replaceImage(int index,
                         Image image)

Replaces an image in the CommandCollection.

Parameters:

index - Index of the image to be replaced.

image - New image to take place of old image.

retainAll

public boolean retainAll(Collection<?> c)

Retains only the elements in the CommandCollection collection that are contained in the specified collection.

Specified by:

retainAll in interface Collection<Command>

Parameters:

c - Elements to be retained in this collection.

setFont

public void setFont(Font value)

Sets the font type which will be used by the commands.

size

public int size()

Returns the number of elements in this collection.

Specified by:

size in interface Collection<Command>

toArray

public Object[] toArray()

Returns an array containing all of the elements in this collection in proper sequence.

Specified by:

toArray in interface Collection<Command>

toArray

public <T> T[] toArray(T[] a)

Returns an array containing all of the elements in this collection in proper sequence.

Specified by:

toArray in interface Collection<Command>