com.tarantella.tta.webservices.client.views
Class WebtopGroup

java.lang.Object
  java.util.AbstractCollection<E>
      java.util.AbstractList<E>
          java.util.Vector
              com.tarantella.tta.webservices.client.views.WebtopGroup

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable, java.util.Collection, java.util.List, java.util.RandomAccess

public class WebtopGroup
extends java.util.Vector

The WebtopGroup class manages a group of assigned applications, typically used by user-defined preferences.

A assigned applications group consists of members and attributes that control its display, for example, whether it should be shown and whether it should be expanded or collapsed. It is used by WebtopGroupContainer and WebtopViewBean.

See Also:

Serialized Form

Constructor Summary

WebtopGroup()
Constructor.

WebtopGroup(java.lang.String name)
Constructor.

WebtopGroup(java.lang.String name, boolean isCollapsed)
Constructor.

WebtopGroup(java.lang.String name, boolean isCollapsed, boolean isShown)
Constructor.

Method Summary

boolean	addMember(java.lang.String member) Adds a member to the group.
boolean	addMember(java.lang.String member, int location) Adds a member to the group at a specific location.
boolean	addMembers(java.lang.String[] members) Adds members to the group.
boolean	containsMember(java.lang.String name) Tests if the group contains the named member.
boolean	dump(java.lang.StringBuffer buffer) Dumps members.
int	findMember(java.lang.String name) Finds the location of the named member.
int	getMemberCount() Gets the number of members in the group.
java.lang.String[]	getMembers() Gets the group members.
java.lang.String	getName() Gets the name of the group.
boolean	isCollapsed() Gets the open/closed state of the group.
boolean	isShown() Gets the visibility of the group.
boolean	load(java.lang.String data) Loads members.
boolean	moveMember(java.lang.String name, int location) Moves a member of the group to a specific location.
boolean	removeMember(int location) Removes a member of the group from a specific location.
boolean	removeMember(java.lang.String name) Removes a named member of the group.
boolean	replaceGroupMembers(java.lang.String[] members) Replaces all group members.
void	setCollapsed(boolean state) Sets the open/closed state of the group.
void	setName(java.lang.String name) Sets the name of the group.
void	setShown(boolean state) Sets the visibility of the group.

Methods inherited from class java.util.Vector

add, add, addAll, addAll, addElement, capacity, clear, clone, contains, containsAll, copyInto, elementAt, elements, ensureCapacity, equals, firstElement, get, hashCode, indexOf, indexOf, insertElementAt, isEmpty, lastElement, lastIndexOf, lastIndexOf, remove, remove, removeAll, removeAllElements, removeElement, removeElementAt, retainAll, set, setElementAt, setSize, size, subList, toArray, toArray, toString, trimToSize

Methods inherited from class java.util.AbstractList

iterator, listIterator, listIterator

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

iterator, listIterator, listIterator

Constructor Detail

WebtopGroup

public WebtopGroup()

Constructor. Creates an unnamed group. By default, the group is collapsed and shown.

Since:

1.0

WebtopGroup

public WebtopGroup(java.lang.String name)

Constructor. Creates a named group. By default, the group is collapsed and shown.

Parameters:

name - The name of the group.

Since:

1.0

WebtopGroup

public WebtopGroup(java.lang.String name,
                   boolean isCollapsed)

Constructor. Creates a named group. By default, the group is shown.

Parameters:

name - The name of the group.

isCollapsed - Flag controlling the open/closed state of the group.

true	the group is initially closed/collapsed
false	the group is initially open

Since:

1.0

WebtopGroup

public WebtopGroup(java.lang.String name,
                   boolean isCollapsed,
                   boolean isShown)

Constructor. Creates a named group.

Parameters:

name - The name of the group.

isCollapsed - Flag controlling the open/closed state of the group.

true	the group is initially closed/collapsed
false	the group is initially open

isShown - Flag controlling the visibility of the group.

true	the group is initially visible/shown
false	the group is initially not shown

Since:

1.0

Method Detail

getName

public java.lang.String getName()

Gets the name of the group.

Returns:

The name of the group. This can be null.

Since:

1.0

isCollapsed

public boolean isCollapsed()

Gets the open/closed state of the group.

Returns:

true	group is closed/collapsed
false	group is open

Since:

1.0

isShown

public boolean isShown()

Gets the visibility of the group.

Returns:

true	group is visible/shown
false	group is not shown

Since:

1.0

setName

public void setName(java.lang.String name)

Sets the name of the group.

Parameters:

name - The name of the group.

Since:

1.0

setCollapsed

public void setCollapsed(boolean state)

Sets the open/closed state of the group.

Parameters:

state - The open/closed state of the group.

true	state is closed/collapsed
false	state is open

Since:

1.0

setShown

public void setShown(boolean state)

Sets the visibility of the group.

Parameters:

state - The visibility of the group.

true	state is visible/shown
false	state is not shown

Since:

1.0

replaceGroupMembers

public boolean replaceGroupMembers(java.lang.String[] members)

Replaces all group members.

Parameters:

members - The new group members.

Returns:

true	members replaced
false	members not replaced

Since:

1.0

getMembers

public java.lang.String[] getMembers()

Gets the group members.

Returns:

The members of the group.

Since:

1.0

addMember

public boolean addMember(java.lang.String member)

Adds a member to the group. The member is added at the end of the group.

Parameters:

member - The new member.

Returns:

true	member added
false	member not added

Since:

1.0

addMember

public boolean addMember(java.lang.String member,
                         int location)

Adds a member to the group at a specific location.

Parameters:

member - The new member.

location - The location at which the member is added.

Returns:

true	member added
false	member not added

Since:

1.0

getMemberCount

public int getMemberCount()

Gets the number of members in the group.

Returns:

The number of members in the group.

Since:

1.0

moveMember

public boolean moveMember(java.lang.String name,
                          int location)

Moves a member of the group to a specific location.

Parameters:

name - The name of the member.

location - The destination location.

Returns:

true	member moved
false	member not moved

Since:

1.0

removeMember

public boolean removeMember(int location)

Removes a member of the group from a specific location.

Parameters:

location - The location of the member to be removed.

Returns:

true	member removed
false	member not removed

Since:

1.0

removeMember

public boolean removeMember(java.lang.String name)

Removes a named member of the group.

Parameters:

name - The name of the member to be removed.

Returns:

true	member removed
false	member not removed

Since:

1.0

addMembers

public boolean addMembers(java.lang.String[] members)

Adds members to the group. Duplicate members are removed.

Parameters:

members - Members to be added.

Returns:

true	members added
false	members not added

Since:

1.0

load

public boolean load(java.lang.String data)

Loads members.

Parameters:

data - Data containing members. Created by dump(StringBuffer).

Returns:

true	members loaded
false	members not loaded

Since:

1.0

dump

public boolean dump(java.lang.StringBuffer buffer)

Dumps members.

Parameters:

buffer - Buffer for members. Can be read by load(String).

Returns:

true	members dumped
false	members not dumped

Since:

1.0

containsMember

public boolean containsMember(java.lang.String name)

Tests if the group contains the named member.

Parameters:

name - The name of the desired member.

Returns:

true	group contains named member
false	group does not contain named member

Since:

1.0

findMember

public int findMember(java.lang.String name)

Finds the location of the named member.

Parameters:

name - The name of the desired member.

Returns:

-1	named member does not exist, or
	the location of the named member

Since:

1.0