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

All Known Implementing Classes:

MetaUIContact, NotificationContact, ShowMoreContact, SourceUIContact

public interface UIContact

The UIContact represents the user interface contact contained in the contact list component.

Author:

Yana Stamcheva

Method Summary

ImageIcon	getAvatar(boolean isSelected, int width, int height) Returns the avatar of this contact.
List<UIContactDetail>	getContactDetailsForOperationSet(Class<? extends OperationSet> opSetClass) Returns a list of all UIContactDetails corresponding to the given OperationSet class.
ContactNode	getContactNode() Returns the corresponding ContactNode.
UIContactDetail	getDefaultContactDetail(Class<? extends OperationSet> opSetClass) Returns the default ContactDetail to use for any operations depending to the given OperationSet class.
Object	getDescriptor() Returns the descriptor of this contact.
String	getDisplayDetails() Returns the display details of this contact.
String	getDisplayName() Returns the display name of this contact.
UIGroup	getParentGroup() Returns the parent group.
JPopupMenu	getRightButtonMenu() Returns the right button menu component.
Iterator<String>	getSearchStrings() Returns an Iterator over a list of the search strings of this contact.
int	getSourceIndex() Returns the index of this contact in its source.
ImageIcon	getStatusIcon() Returns the status icon of this contact or null if no status is available.
ExtendedTooltip	getToolTip() Creates a tool tip for this contact.
void	setContactNode(ContactNode contactNode) Sets the given contactNode.
void	setParentGroup(UIGroup parentGroup) Sets the given UIGroup to be the parent group of this UIContact.

Method Detail

getDescriptor

Object getDescriptor()

Returns the descriptor of this contact.

Returns:

the descriptor of this contact

getDisplayName

String getDisplayName()

Returns the display name of this contact.

Returns:

the display name of this contact

getDisplayDetails

String getDisplayDetails()

Returns the display details of this contact. These would be shown whenever the contact is selected.

Returns:

the display details of this contact

getSourceIndex

int getSourceIndex()

Returns the index of this contact in its source.

Returns:

the source index

getAvatar

ImageIcon getAvatar(boolean isSelected,
                    int width,
                    int height)

Returns the avatar of this contact.

Parameters:

isSelected - indicates if the contact is selected

width - the width of the avatar

height - the height of the avatar

Returns:

the avatar of this contact

getStatusIcon

ImageIcon getStatusIcon()

Returns the status icon of this contact or null if no status is available.

Returns:

the status icon of this contact or null if no status is available

getToolTip

ExtendedTooltip getToolTip()

Creates a tool tip for this contact. If such tooltip is provided it would be shown on mouse over over this UIContact.

Returns:

the tool tip for this contact descriptor

getRightButtonMenu

JPopupMenu getRightButtonMenu()

Returns the right button menu component.

Returns:

the right button menu component

getParentGroup

UIGroup getParentGroup()

Returns the parent group.

Returns:

the parent group

setParentGroup

void setParentGroup(UIGroup parentGroup)

Sets the given UIGroup to be the parent group of this UIContact.

Parameters:

parentGroup - the parent UIGroup of this contact

getSearchStrings

Iterator<String> getSearchStrings()

Returns an Iterator over a list of the search strings of this contact.

Returns:

an Iterator over a list of the search strings of this contact

getContactNode

ContactNode getContactNode()

Returns the corresponding ContactNode. The ContactNode is the real node that is stored in the contact list component data model.

Returns:

the corresponding ContactNode

setContactNode

void setContactNode(ContactNode contactNode)

Sets the given contactNode. The ContactNode is the real node that is stored in the contact list component data model.

Parameters:

contactNode - the ContactNode that corresponds to this UIGroup

getDefaultContactDetail

UIContactDetail getDefaultContactDetail(Class<? extends OperationSet> opSetClass)

Returns the default ContactDetail to use for any operations depending to the given OperationSet class.

Parameters:

opSetClass - the OperationSet class we're interested in

Returns:

the default ContactDetail to use for any operations depending to the given OperationSet class

getContactDetailsForOperationSet

List<UIContactDetail> getContactDetailsForOperationSet(Class<? extends OperationSet> opSetClass)

Returns a list of all UIContactDetails corresponding to the given OperationSet class.

Parameters:

opSetClass - the OperationSet class we're looking for

Returns:

a list of all UIContactDetails corresponding to the given OperationSet class