net.java.sip.communicator.impl.gui.main.contactlist
Interface UIGroup

All Known Implementing Classes:

MetaUIGroup, NotificationGroup

public interface UIGroup

The UIGroup represents the user interface contact list group.

Author:

Yana Stamcheva

Method Summary

int	countChildContacts() Returns the child contacts count.
int	countOnlineChildContacts() Returns the count of online child contacts.
Object	getDescriptor() Returns the descriptor of the group.
String	getDisplayName() The display name of the group.
GroupNode	getGroupNode() Returns the GroupNode corresponding to this UIGroup.
String	getId() Returns the identifier of this group.
UIGroup	getParentGroup() Returns the parent group.
JPopupMenu	getRightButtonMenu() Returns the right button menu for this group.
int	getSourceIndex() Returns the index of this group in its source.
boolean	isGroupCollapsed() Indicates if the group is collapsed or expanded.
void	setGroupNode(GroupNode groupNode) Sets the GroupNode corresponding to this UIGroup.

Method Detail

getDescriptor

Object getDescriptor()

Returns the descriptor of the group. This would be the underlying object that should provide all other necessary information for the group.

Returns:

the descriptor of the group

getDisplayName

String getDisplayName()

The display name of the group. The display name is the name to be shown in the contact list group row.

Returns:

the display name of the group

getSourceIndex

int getSourceIndex()

Returns the index of this group in its source. In other words this is the descriptor index.

Returns:

the index of this group in its source

getParentGroup

UIGroup getParentGroup()

Returns the parent group.

Returns:

the parent group

isGroupCollapsed

boolean isGroupCollapsed()

Indicates if the group is collapsed or expanded.

Returns:

true to indicate that the group is collapsed, false to indicate that it's expanded

countOnlineChildContacts

int countOnlineChildContacts()

Returns the count of online child contacts.

Returns:

the count of online child contacts

countChildContacts

int countChildContacts()

Returns the child contacts count.

Returns:

child contacts count

getId

String getId()

Returns the identifier of this group.

Returns:

the identifier of this group

getGroupNode

GroupNode getGroupNode()

Returns the GroupNode corresponding to this UIGroup. The is the actual node used in the contact list component data model.

Returns:

the GroupNode corresponding to this UIGroup

setGroupNode

void setGroupNode(GroupNode groupNode)

Sets the GroupNode corresponding to this UIGroup.

Parameters:

groupNode - the GroupNode to set. The is the actual node used in the contact list component data model.

getRightButtonMenu

JPopupMenu getRightButtonMenu()

Returns the right button menu for this group.

Returns:

the right button menu component for this group