path: root/src/net/java/sip/communicator/impl/gui/main/contactlist/ContactListTreeCellRenderer.java

/*
 * Jitsi, the OpenSource Java VoIP and Instant Messaging client.
 *
 * Copyright @ 2015 Atlassian Pty Ltd
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.java.sip.communicator.impl.gui.main.contactlist;

import java.awt.*;
import java.awt.event.*;
import java.util.*;
import java.util.List;

import javax.swing.*;
import javax.swing.JPopupMenu.Separator;
import javax.swing.tree.*;

import org.jitsi.util.*;

import net.java.sip.communicator.impl.gui.*;
import net.java.sip.communicator.impl.gui.main.call.*;
import net.java.sip.communicator.impl.gui.main.contactlist.contactsource.*;
import net.java.sip.communicator.impl.gui.utils.*;
import net.java.sip.communicator.plugin.desktoputil.*;
import net.java.sip.communicator.service.contactlist.*;
import net.java.sip.communicator.service.contactsource.*;
import net.java.sip.communicator.service.gui.*;
import net.java.sip.communicator.service.muc.*;
import net.java.sip.communicator.service.protocol.*;
import net.java.sip.communicator.service.protocol.OperationSetServerStoredContactInfo.*;
import net.java.sip.communicator.service.protocol.ServerStoredDetails.*;
import net.java.sip.communicator.util.*;
import net.java.sip.communicator.util.account.*;
import net.java.sip.communicator.util.call.*;
import net.java.sip.communicator.util.skin.*;

/**
 * The <tt>ContactListCellRenderer</tt> is the custom cell renderer used in the
 * Jitsi's <tt>ContactList</tt>. It extends JPanel instead of JLabel,
 * which allows adding different buttons and icons to the contact cell. The cell
 * border and background are repainted.
 *
 * @author Yana Stamcheva
 * @author Lubomir Marinov
 * @author Adam Netocny
 * @author Hristo Terezov
 */
public class ContactListTreeCellRenderer
    extends JPanel
    implements  TreeCellRenderer,
                Icon,
                Skinnable
{
    /**
     * Serial version UID.
     */
    private static final long serialVersionUID = 0L;

    /**
     * The default height of the avatar.
     */
    private static final int AVATAR_HEIGHT = 30;

    /**
     * The default width of the avatar.
     */
    private static final int AVATAR_WIDTH = 30;

    /**
     * The extended height of the avatar.
     */
    private static final int EXTENDED_AVATAR_HEIGHT = 45;

    /**
     * The extended width of the avatar.
     */
    private static final int EXTENDED_AVATAR_WIDTH = 45;

    /**
     * The default width of the button.
     */
    private static final int BUTTON_WIDTH = 26;

    /**
     * The default height of the button.
     */
    private static final int BUTTON_HEIGHT = 27;

    /**
     * Left border value.
     */
    private static final int LEFT_BORDER = 5;

    /**
     * Left border value.
     */
    private static final int TOP_BORDER = 2;

    /**
     * Bottom border value.
     */
    private static final int BOTTOM_BORDER = 2;

    /**
     * Right border value.
     */
    private static final int RIGHT_BORDER = 2;

    /**
     * The horizontal gap between columns in pixels;
     */
    private static final int H_GAP = 2;

    /**
     * The vertical gap between rows in pixels;
     */
    private static final int V_GAP = 2;

    /**
     * The calculated preferred height of a selected contact node.
     */
    private Integer preferredSelectedContactNodeHeight = null;

    /**
     * The calculated preferred height of a non selected contact node.
     */
    private Integer preferredNotSelectedContactNodeHeight = null;

    /**
     * The calculated preferred height of a group node.
     */
    private Integer preferredGroupNodeHeight = null;

    /**
     * The separator image for the button toolbar.
     */
    private static final Image BUTTON_SEPARATOR_IMG
        = ImageLoader.getImage(ImageLoader.CONTACT_LIST_BUTTON_SEPARATOR);

    /**
     * The icon used for opened groups.
     */
    private ImageIcon openedGroupIcon;

    /**
     * The icon used for closed groups.
     */
    private ImageIcon closedGroupIcon;

    /**
     * The foreground color for groups.
     */
    private Color groupForegroundColor;

    /**
     * The foreground color for contacts.
     */
    private Color contactForegroundColor;

    /**
     * The component showing the name of the contact or group.
     */
    private final JLabel nameLabel = new JLabel();

    /**
     * The status message label.
     */
    private final JLabel displayDetailsLabel = new JLabel();

    /**
     * The call button.
     */
    private final SIPCommButton callButton = new SIPCommButton();

    /**
     * The call video button.
     */
    private final SIPCommButton callVideoButton = new SIPCommButton();

    /**
     * The desktop sharing button.
     */
    private final SIPCommButton desktopSharingButton = new SIPCommButton();

    /**
     * The chat button.
     */
    private final SIPCommButton chatButton = new SIPCommButton();

    /**
     * The web button.
     */
    private final WebButton webButton = new WebButton();

    /**
     * The add contact button.
     */
    private final SIPCommButton addContactButton = new SIPCommButton();

    /**
     * The constraints used to align components in the <tt>centerPanel</tt>.
     */
    private final GridBagConstraints constraints = new GridBagConstraints();

    /**
     * The component showing the avatar or the contact count in the case of
     * groups.
     */
    protected final JLabel rightLabel = new JLabel();

    /**
     * The message received image.
     */
    private Image msgReceivedImage;

    /**
     * The label containing the status icon.
     */
    private final JLabel statusLabel = new JLabel();

    /**
     * The icon showing the contact status.
     */
    protected Icon statusIcon = new ImageIcon();

    /**
     * Indicates if the current list cell is selected.
     */
    protected boolean isSelected = false;

    /**
     * The index of the current cell.
     */
    protected int row = 0;

    /**
     * Indicates if the current cell contains a leaf or a group.
     */
    protected TreeNode treeNode = null;

    /**
     * The parent tree.
     */
    private TreeContactList treeContactList;

    /**
     * A list of the custom action buttons for contacts UIContacts.
     */
    private List<JButton> customActionButtons;

    /**
     * A list of the custom action buttons for groups.
     */
    private List<JButton> customActionButtonsUIGroup;

    /**
     * The last added button.
     */
    private SIPCommButton lastAddedButton;

    /**
     * Initializes the panel containing the node.
     */
    public ContactListTreeCellRenderer()
    {
        super(new GridBagLayout());

        loadSkin();

        setOpaque(true);
        nameLabel.setOpaque(false);

        displayDetailsLabel.setFont(getFont().deriveFont(9f));
        displayDetailsLabel.setForeground(Color.GRAY);

        rightLabel.setHorizontalAlignment(JLabel.RIGHT);

        // !! IMPORTANT: General insets used for all components if not
        // overwritten!
        constraints.insets = new Insets(0, 0, 0, H_GAP);

        constraints.anchor = GridBagConstraints.WEST;
        constraints.fill = GridBagConstraints.NONE;
        constraints.gridx = 0;
        constraints.gridy = 0;
        constraints.gridheight = 1;
        constraints.weightx = 0f;
        constraints.weighty = 1f;
        add(statusLabel, constraints);

        addLabels(1);

        callButton.addActionListener(new ActionListener()
        {
            public void actionPerformed(ActionEvent e)
            {
                if (treeNode != null && treeNode instanceof ContactNode)
                {
                    call(treeNode, callButton, false, false);
                }
            }
        });

        callVideoButton.addActionListener(new ActionListener()
        {
            public void actionPerformed(ActionEvent e)
            {
                if (treeNode != null && treeNode instanceof ContactNode)
                {
                    call(treeNode, callVideoButton, true, false);
                }
            }
        });

        desktopSharingButton.addActionListener(new ActionListener()
        {
            public void actionPerformed(ActionEvent e)
            {
                if (treeNode != null && treeNode instanceof ContactNode)
                {
                    call(treeNode, desktopSharingButton, true, true);
                }
            }
        });

        chatButton.addActionListener(new ActionListener()
        {
            public void actionPerformed(ActionEvent e)
            {
                if (treeNode != null && treeNode instanceof ContactNode)
                {
                    UIContact contactDescriptor
                        = ((ContactNode) treeNode).getContactDescriptor();

                    if (contactDescriptor.getDescriptor()
                            instanceof MetaContact)
                    {
                        GuiActivator.getUIService().getChatWindowManager()
                            .startChat(
                                (MetaContact) contactDescriptor.getDescriptor());
                    }
                    else if(contactDescriptor.getDescriptor()
                            instanceof SourceContact)
                    {
                        SourceContact contact = (SourceContact)
                            contactDescriptor.getDescriptor();

                        List<ContactDetail> imDetails
                            = contact.getContactDetails(
                                OperationSetBasicInstantMessaging.class);
                        List<ContactDetail> mucDetails
                            = contact.getContactDetails(
                                OperationSetMultiUserChat.class);

                        if(imDetails != null && imDetails.size() > 0)
                        {
                            ProtocolProviderService pps
                                = imDetails.get(0).getPreferredProtocolProvider(
                                    OperationSetBasicInstantMessaging.class);

                            if (pps != null)
                                GuiActivator.getUIService().getChatWindowManager()
                                    .startChat(contact.getContactAddress(),
                                               pps);
                            else
                                GuiActivator.getUIService().getChatWindowManager()
                                    .startChat(contact.getContactAddress());
                        }
                        else if(mucDetails != null && mucDetails.size() > 0)
                        {
                            ChatRoomWrapper room = GuiActivator.getMUCService()
                                .findChatRoomWrapperFromSourceContact(contact);

                            if(room == null)
                            {
                                // lets check by id
                                ProtocolProviderService pps =
                                    mucDetails.get(0)
                                        .getPreferredProtocolProvider(
                                            OperationSetMultiUserChat.class);

                                room = GuiActivator.getMUCService()
                                    .findChatRoomWrapperFromChatRoomID(
                                        contact.getContactAddress(), pps);

                                if(room == null)
                                {
                                    GuiActivator.getMUCService().createChatRoom(
                                        contact.getContactAddress(),
                                        pps,
                                        new ArrayList<String>(),
                                        "",
                                        false,
                                        false,
                                        false);
                                }
                            }

                            if(room != null)
                                GuiActivator.getMUCService().openChatRoom(room);
                        }
                    }
                }
            }
        });

        addContactButton.addActionListener(new ActionListener()
        {
            public void actionPerformed(ActionEvent e)
            {
                if (treeNode != null && treeNode instanceof ContactNode)
                {
                    UIContact contactDescriptor
                        = ((ContactNode) treeNode).getContactDescriptor();

                    // The add contact function has only sense for external
                    // source contacts.
                    if (contactDescriptor instanceof SourceUIContact)
                    {
                        addContact((SourceUIContact) contactDescriptor);
                    }
                }
            }
        });
        webButton.addActionListener(new ActionListener()
        {
            public void actionPerformed(ActionEvent e)
            {
                openURL(treeContactList, treeNode, webButton);
            }
        });

        initButtonToolTips();
        setToolTipText("");
    }

    /**
     * Returns this panel that has been configured to display the meta contact
     * and meta contact group cells.
     *
     * @param tree the source tree
     * @param value the tree node
     * @param selected indicates if the node is selected
     * @param expanded indicates if the node is expanded
     * @param leaf indicates if the node is a leaf
     * @param row indicates the row number of the node
     * @param hasFocus indicates if the node has the focus
     * @return this panel
     */
    public Component getTreeCellRendererComponent(JTree tree, Object value,
        boolean selected, boolean expanded, boolean leaf, int row,
        boolean hasFocus)
    {
        this.treeContactList = (TreeContactList) tree;
        this.row = row;
        this.isSelected = selected;
        this.treeNode = (TreeNode) value;

        rightLabel.setIcon(null);

        DefaultTreeContactList contactList = (DefaultTreeContactList) tree;

        setBorder();
        addLabels(1);

        // Set background color.
        if (contactList instanceof TreeContactList)
        {
            ContactListFilter filter
                = ((TreeContactList) contactList).getCurrentFilter();

            if (filter != null
                && filter.equals(TreeContactList.historyFilter)
                && value instanceof ContactNode
                && row%2 == 0)
            {
                setBackground(Constants.CALL_HISTORY_EVEN_ROW_COLOR);
            }
            else
            {
                setBackground(Color.WHITE);
            }
        }

        // clear icon if any (mobile indicator)
        nameLabel.setIcon(null);
        // TODO: remove debugging
        nameLabel.setText(value.toString());

        // Make appropriate adjustments for contact nodes and group nodes.
        if (value instanceof ContactNode)
        {
            UIContactImpl contact
                = ((ContactNode) value).getContactDescriptor();

            MUCService mucService;
            if((contact.getDescriptor() instanceof SourceContact)
                && (mucService = GuiActivator.getMUCService()) != null
                && mucService.isMUCSourceContact(
                        (SourceContact) contact.getDescriptor()))
            {
                setBackground(Constants.CHAT_ROOM_ROW_COLOR);
            }

            String displayName = contact.getDisplayName();
            if ((displayName == null
                || displayName.trim().length() < 1)
                && !(contact instanceof ShowMoreContact))
            {
                displayName = GuiActivator.getResources()
                    .getI18NString("service.gui.UNKNOWN");
            }

            nameLabel.setText(displayName);

            if(statusIcon != null
                && contactList.isContactActive(contact)
                && statusIcon instanceof ImageIcon)
                ((ImageIcon) statusIcon).setImage(msgReceivedImage);
            else
                statusIcon = contact.getStatusIcon();

            statusLabel.setIcon(statusIcon);

            /*
             * FIXME A hard-coded absolute font size is surely not appropriate
             * because it is completely oblivious of the default system font
             * size. A JLabel will very likely use the closest to the default
             * system font (size) so there is no reason to specify any font size
             * here, let alone a hard-coded absolute one. Anyway, use a
             * hard-coded absolute font size but at least do not fall bellow the
             * default system font size. On second thought, we are pretty sure
             * that we are using the default system font on Windows and it makes
             * no sense whatsoever to change its size.
             */
            Font nameLabelFont = nameLabel.getFont();

            nameLabel.setFont(
                    nameLabelFont.deriveFont(
                            Font.PLAIN,
                            Math.max(
                                    nameLabelFont.getSize2D(),
                                    OSUtils.IS_WINDOWS ? 0F : 13F)));

            if (contactForegroundColor != null)
                nameLabel.setForeground(contactForegroundColor);

            // Initializes status message components if the given meta contact
            // contains a status message.
            initDisplayDetails(contact.getDisplayDetails());

            // Checks and set mobile indicator
            if (contact.getDescriptor() instanceof MetaContact
                && isMobile((MetaContact)contact.getDescriptor()))
            {
                nameLabel.setIcon(
                        new ImageIcon(
                                ImageLoader.getImage(
                                        ImageLoader
                                            .CONTACT_LIST_MOBILE_INDICATOR)));
                nameLabel.setHorizontalTextPosition(SwingConstants.LEFT);
            }

            if (treeContactList.isContactButtonsVisible())
                initButtonsPanel(contact);

            int avatarWidth, avatarHeight;

            if (isSelected && treeContactList.isContactButtonsVisible())
            {
                avatarWidth = EXTENDED_AVATAR_WIDTH;
                avatarHeight = EXTENDED_AVATAR_HEIGHT;
            }
            else
            {
                avatarWidth = AVATAR_WIDTH;
                avatarHeight = AVATAR_HEIGHT;
            }

            Icon avatar
                = contact.getScaledAvatar(
                        isSelected,
                        avatarWidth, avatarHeight);

            if (avatar != null)
                rightLabel.setIcon(avatar);

            if (contact instanceof ShowMoreContact)
            {
                rightLabel.setFont(rightLabel.getFont().deriveFont(12f));
                rightLabel.setForeground(Color.GRAY);
                rightLabel.setText((String)contact.getDescriptor());
            }
            else
            {
                rightLabel.setFont(rightLabel.getFont().deriveFont(9f));
                rightLabel.setText("");
            }

            setToolTipText(contact.getDescriptor().toString());

            // lets calculate the height of contact node, if not done already
            if(preferredNotSelectedContactNodeHeight == null)
            {
                preferredNotSelectedContactNodeHeight
                    = ComponentUtils.getStringHeight(nameLabel)
                    + V_GAP * 2
                    + ComponentUtils.getStringHeight(displayDetailsLabel);

                preferredSelectedContactNodeHeight =
                    preferredNotSelectedContactNodeHeight
                        + V_GAP * 2
                        + BUTTON_HEIGHT;
            }
        }
        else if (value instanceof GroupNode)
        {
            UIGroupImpl groupItem
                = ((GroupNode) value).getGroupDescriptor();

            /*
             * FIXME A hard-coded absolute font size is surely not appropriate
             * because it is completely oblivious of the default system font
             * size. A JLabel will very likely use the closest to the default
             * system font (size) so there is no reason to specify any font size
             * here, let alone a hard-coded absolute one. Anyway, use a
             * hard-coded absolute font size but at least do not fall bellow the
             * default system font size. On second thought, we are pretty sure
             * that we are using the default system font on Windows and it makes
             * no sense whatsoever to change its size.
             */
            Font nameLabelFont = nameLabel.getFont();

            nameLabel.setFont(
                    nameLabelFont.deriveFont(
                            Font.BOLD,
                            Math.max(
                                    nameLabelFont.getSize2D(),
                                    OSUtils.IS_WINDOWS ? 0F : 13F)));
            nameLabel.setText(groupItem.getDisplayName());

            if (groupForegroundColor != null)
                nameLabel.setForeground(groupForegroundColor);

            remove(displayDetailsLabel);
            remove(callButton);
            remove(callVideoButton);
            remove(desktopSharingButton);
            remove(chatButton);
            remove(addContactButton);
            remove(webButton);

            clearCustomActionButtons();

            statusIcon = expanded
                                ? openedGroupIcon
                                : closedGroupIcon;

            if(groupItem != treeContactList.getRootUIGroup())
            {
                statusLabel.setIcon(
                        expanded
                            ? openedGroupIcon
                            : closedGroupIcon);
            }
            else
            {
                statusLabel.setIcon(null);
            }

            // We have no photo icon for groups.
            rightLabel.setIcon(null);
            rightLabel.setText("");

            int groupItemCountChildContacts = groupItem.countChildContacts();

            if (groupItemCountChildContacts >= 0)
            {
                rightLabel.setFont(rightLabel.getFont().deriveFont(9f));
                rightLabel.setForeground(Color.BLACK);
                rightLabel.setText(
                        groupItem.countOnlineChildContacts() + "/"
                            + groupItemCountChildContacts);
            }

            initDisplayDetails(groupItem.getDisplayDetails());
            initButtonsPanel(groupItem);

            Object groupItemDescriptor = groupItem.getDescriptor();

            setToolTipText(
                    (groupItemDescriptor != null)
                        ? groupItemDescriptor.toString()
                        : groupItem.getDisplayName());

            // lets calculate group node height, if not done already
            if(preferredGroupNodeHeight == null)
            {
                preferredGroupNodeHeight =
                    ComponentUtils.getStringHeight(nameLabel);
            }
        }

        return this;
    }

    /**
     * Checks whether metaContact has mobile indicator.
     * Needs all of the contacts to have it to indicate it.
     * @param metaContact the metacontact to check for mobile indicator
     * @return whether to indicate contact as mobile one.
     */
    private boolean isMobile(MetaContact metaContact)
    {
        boolean hasConnectedStatus = false;
        Iterator<Contact> iter = metaContact.getContacts();
        while(iter.hasNext())
        {
            Contact contact = iter.next();

            boolean isConnected = contact.getPresenceStatus().isOnline();

            if(isConnected)
                hasConnectedStatus = true;

            if(isConnected && !contact.isMobile())
                return false;
        }

        if(!hasConnectedStatus)
            return false;
        else
            return metaContact.getContactCount() > 0 ? true : false;
    }

    /**
     * Paints a customized background.
     *
     * @param g the <tt>Graphics</tt> object through which we paint
     */
    @Override
    protected void paintComponent(Graphics g)
    {
        super.paintComponent(g);

        g = g.create();

        if (!(treeNode instanceof GroupNode) && !isSelected)
            return;

        AntialiasingManager.activateAntialiasing(g);

        Graphics2D g2 = (Graphics2D) g;

        try
        {
            internalPaintComponent(g2);
        }
        finally
        {
            g.dispose();
        }
    }

    /**
     * Paint a background for all groups and a round blue border and background
     * when a cell is selected.
     *
     * @param g2 the <tt>Graphics2D</tt> object through which we paint
     */
    private void internalPaintComponent(Graphics2D g2)
    {
        Color borderColor = Color.GRAY;

        if (isSelected)
        {
            g2.setPaint(new GradientPaint(0, 0,
                Constants.SELECTED_COLOR, 0, getHeight(),
                Constants.SELECTED_GRADIENT_COLOR));

            borderColor = Constants.SELECTED_COLOR;
        }
        else if (treeNode instanceof GroupNode)
        {
            g2.setPaint(new GradientPaint(0, 0,
                Constants.CONTACT_LIST_GROUP_BG_GRADIENT_COLOR,
                0, getHeight(),
                Constants.CONTACT_LIST_GROUP_BG_COLOR));

            borderColor = Constants.CONTACT_LIST_GROUP_BG_COLOR;
        }

        g2.fillRect(0, 0, getWidth(), getHeight());
        g2.setColor(borderColor);
        g2.drawLine(0, 0, getWidth(), 0);
        g2.drawLine(0, getHeight() - 1, getWidth(), getHeight() - 1);
    }

    /**
     * Returns the height of this icon. Used for the drag&drop component.
     * @return the height of this icon
     */
    public int getIconHeight()
    {
        return getPreferredSize().height + 10;
    }

    /**
     * Returns the width of this icon. Used for the drag&drop component.
     * @return the widht of this icon
     */
    public int getIconWidth()
    {
        return treeContactList.getWidth() + 10;
    }

    /**
     * Returns the preferred size of this component.
     * @return the preferred size of this component
     */
    @Override
    public Dimension getPreferredSize()
    {
        Dimension preferredSize = new Dimension();
        int preferredHeight;

        if (treeNode instanceof ContactNode)
        {
            UIContact contact
                = ((ContactNode) treeNode).getContactDescriptor();

            preferredHeight = contact.getPreferredHeight();

            if (preferredHeight > 0)
                preferredSize.height = preferredHeight;
            else if (contact instanceof ShowMoreContact)
            {
                // will reuse preferredGroupNodeHeight if available
                // as it is the same height (one line text)
                if(preferredGroupNodeHeight != null)
                    preferredSize.height = preferredGroupNodeHeight;
                else
                    preferredSize.height = 20;
            }
            else if (isSelected && treeContactList.isContactButtonsVisible())
            {
                if(preferredSelectedContactNodeHeight != null)
                    preferredSize.height = preferredSelectedContactNodeHeight;
                else
                    preferredSize.height = 70;
            }
            else
            {
                if(preferredNotSelectedContactNodeHeight != null)
                    preferredSize.height
                        = preferredNotSelectedContactNodeHeight;
                else
                    preferredSize.height = 35;
            }
        }
        else if (treeNode instanceof GroupNode)
        {
            UIGroup group
                = ((GroupNode) treeNode).getGroupDescriptor();

            preferredHeight = group.getPreferredHeight();

            if (isSelected
                    && customActionButtonsUIGroup != null
                    && !customActionButtonsUIGroup.isEmpty())
            {
                if(preferredGroupNodeHeight != null)
                {
                    preferredSize.height = preferredGroupNodeHeight
                        + V_GAP
                        + BUTTON_HEIGHT;
                }
                else
                    preferredSize.height = 70;
            }
            else if (preferredHeight > 0)
                preferredSize.height = preferredHeight;
            else
            {
                if(preferredGroupNodeHeight != null)
                    preferredSize.height = preferredGroupNodeHeight;
                else
                    preferredSize.height = 20;
            }
        }

        return preferredSize;
    }

    /**
     * Adds contact entry labels.
     *
     * @param nameLabelGridWidth the grid width of the contact entry name
     * label
     */
    private void addLabels(int nameLabelGridWidth)
    {
        remove(nameLabel);
        remove(rightLabel);
        remove(displayDetailsLabel);

        if (treeNode != null && !(treeNode instanceof GroupNode))
            constraints.insets = new Insets(0, 0, V_GAP, H_GAP);
        else
            constraints.insets = new Insets(0, 0, 0, H_GAP);

        constraints.anchor = GridBagConstraints.WEST;
        constraints.fill = GridBagConstraints.NONE;
        constraints.gridx = 1;
        constraints.gridy = 0;
        constraints.weightx = 1f;
        constraints.weighty = 0f;
        constraints.gridheight = 1;
        constraints.gridwidth = nameLabelGridWidth;
        add(nameLabel, constraints);

        constraints.anchor = GridBagConstraints.NORTHEAST;
        constraints.fill = GridBagConstraints.VERTICAL;
        constraints.gridx = nameLabelGridWidth + 1;
        constraints.gridy = 0;
        constraints.gridheight = 3;
        constraints.weightx = 0f;
        constraints.weighty = 1f;
        add(rightLabel, constraints);

        if (treeNode != null && treeNode instanceof ContactNode)
        {
            constraints.anchor = GridBagConstraints.WEST;
            constraints.fill = GridBagConstraints.NONE;
            constraints.gridx = 1;
            constraints.gridy = 1;
            constraints.weightx = 1f;
            constraints.weighty = 0f;
            constraints.gridwidth = nameLabelGridWidth;
            constraints.gridheight = 1;

            add(displayDetailsLabel, constraints);
        }
    }

    /**
     * Initializes the display details component for the given
     * <tt>UIContact</tt>.
     * @param displayDetails the display details to show
     */
    private void initDisplayDetails(String displayDetails)
    {
        remove(displayDetailsLabel);
        displayDetailsLabel.setText("");

        if (displayDetails != null && displayDetails.length() > 0)
        {
            // Replace all occurrences of new line with slash.
            displayDetails = Html2Text.extractText(displayDetails);
            displayDetails = displayDetails.replaceAll("\n|<br>|<br/>", " / ");

            displayDetailsLabel.setText(displayDetails);
        }

        constraints.anchor = GridBagConstraints.WEST;
        constraints.fill = GridBagConstraints.NONE;
        constraints.gridx = 1;
        constraints.gridy = 1;
        constraints.weightx = 1f;
        constraints.weighty = 0f;
        constraints.gridwidth = 1;
        constraints.gridheight = 1;

        add(displayDetailsLabel, constraints);
    }

    /**
     * Initializes buttons panel.
     * @param uiContact the <tt>UIContact</tt> for which we initialize the
     * button panel
     */
    private void initButtonsPanel(UIContact uiContact)
    {
        remove(chatButton);
        remove(callButton);
        remove(callVideoButton);
        remove(desktopSharingButton);
        remove(addContactButton);
        remove(webButton);

        clearCustomActionButtons();

        if (!isSelected)
            return;

        UIContactDetail imContact = null;
        if (uiContact.getDescriptor() instanceof MetaContact ||
            uiContact.getDescriptor() instanceof SourceContact)
            imContact = uiContact.getDefaultContactDetail(
                         OperationSetBasicInstantMessaging.class);

        if(imContact == null)
            imContact = uiContact.getDefaultContactDetail(
                OperationSetMultiUserChat.class);

        int x = (statusIcon == null ? 0 : statusIcon.getIconWidth())
                + LEFT_BORDER
                + H_GAP;

        // Re-initialize the x grid.
        constraints.gridx = 0;
        int gridX = 0;

        if (imContact != null)
        {
            x += addButton(chatButton, ++gridX, x, false, true);
        }

        UIContactDetail telephonyContact
            = uiContact.getDefaultContactDetail(
                OperationSetBasicTelephony.class);

        // Check if contact has additional phone numbers, if yes show the
        // call button
        MetaContactPhoneUtil contactPhoneUtil = null;
        DetailsResponseListener detailsListener = null;

        // check for phone stored in contact info only
        // if telephony contact is missing
        if(uiContact.getDescriptor() != null
           && uiContact.getDescriptor() instanceof MetaContact
           && telephonyContact == null)
        {
            contactPhoneUtil = MetaContactPhoneUtil.getPhoneUtil(
                (MetaContact)uiContact.getDescriptor());

            detailsListener
                = new DetailsListener(treeNode, callButton, uiContact);
        }

        // for SourceContact in history that do not support telephony, we
        // show the button but disabled
        List<ProtocolProviderService> providers
            = AccountUtils.getOpSetRegisteredProviders(
                OperationSetBasicTelephony.class,
                null,
                null);

        if ((telephonyContact != null && telephonyContact.getAddress() != null)
            || (contactPhoneUtil != null
                && contactPhoneUtil.isCallEnabled(detailsListener)
                && providers.size() > 0))
        {
            x += addButton(callButton, ++gridX, x, false, true);
        }

        UIContactDetail videoContact
            = uiContact.getDefaultContactDetail(
                OperationSetVideoTelephony.class);

        if (videoContact != null
            || (contactPhoneUtil != null
                && contactPhoneUtil.isVideoCallEnabled(detailsListener)))
        {
            x += addButton(callVideoButton, ++gridX, x, false, true);
        }

        UIContactDetail desktopContact
            = uiContact.getDefaultContactDetail(
                OperationSetDesktopSharingServer.class);

        if (desktopContact != null
            || (contactPhoneUtil != null
                && contactPhoneUtil.isDesktopSharingEnabled(detailsListener)))
        {
            x += addButton(desktopSharingButton, ++gridX, x, false, true);
        }

        // enable add contact button if contact source has indicated
        // that this is possible
        if (uiContact.getDescriptor() instanceof SourceContact
            && uiContact.getDefaultContactDetail(
                    OperationSetPersistentPresence.class) != null
            && AccountUtils.getOpSetRegisteredProviders(
                    OperationSetPersistentPresence.class,
                    null,
                    null).size() > 0
            && !ConfigurationUtils.isAddContactDisabled())
        {
            x += addButton(addContactButton, ++gridX, x, false, true);
        }

        //webButton
        if (uiContact.getDescriptor() instanceof MetaContact)
        {
            // first check for web page detail
            WebDetailsListener webDetailsListener =
                new WebDetailsListener(treeNode, webButton, uiContact);

            List<URLDetail> dets =
                getURLDetails(uiContact, webDetailsListener, true);
            if(dets != null && dets.size() > 0)
            {
                x += addButton(webButton, ++gridX, x, false, true);

                webButton.setLinksFromURLDetail(dets);
            }
            else
                webButton.clearLinks();
        }
        else if (uiContact.getDescriptor() instanceof SourceContact)
        {
            SourceContact srcContact =
                (SourceContact) uiContact.getDescriptor();

            try
            {
                List<ContactDetail> dets = srcContact.getContactDetails(
                    ContactDetail.Category.Web);
                if(dets != null && dets.size() > 0)
                {
                    x += addButton(webButton, ++gridX, x, false, true);

                    webButton.setLinksFromContactDetail(dets);
                }
                else
                    webButton.clearLinks();
            }
            catch(OperationNotSupportedException e)
            {} // ignore records that don't support it
        }

        // The list of the contact actions
        // we will create a button for every action
        Collection<? extends JButton> contactActions
            = uiContact.getContactCustomActionButtons();

        int lastGridX = gridX;
        if (contactActions != null && contactActions.size() > 0)
        {
            lastGridX = initContactActionButtons(contactActions, gridX, x);
        }
        else
        {
            addLabels(gridX);
        }

        if (lastAddedButton != null)
            setButtonBg(lastAddedButton, lastGridX, true);

        setBounds(0, 0, treeContactList.getWidth(), getPreferredSize().height);
    }

    /**
     * Initializes buttons panel.
     * @param uiGroup the <tt>UIGroup</tt> for which we initialize the
     * button panel
     */
    private void initButtonsPanel(UIGroup uiGroup)
    {
        if (!isSelected)
            return;

        int x = (statusIcon == null ? 0 : statusIcon.getIconWidth())
                + LEFT_BORDER
                + H_GAP;
        int gridX = 0;

        // The list of the actions
        // we will create a button for every action
        Collection<? extends JButton> contactActions
            = uiGroup.getCustomActionButtons();

        int lastGridX = gridX;
        if (contactActions != null && contactActions.size() > 0)
        {
            lastGridX = initGroupActionButtons(contactActions, gridX, x);
        }
        else
        {
            addLabels(gridX);
        }

        if (lastAddedButton != null)
            setButtonBg(lastAddedButton, lastGridX, true);

        setBounds(0, 0, treeContactList.getWidth(), getPreferredSize().height);
    }

    /**
     * Clears the custom action buttons.
     */
    private void clearCustomActionButtons()
    {
        if (customActionButtons != null && customActionButtons.size() > 0)
        {
            Iterator<JButton> buttonsIter = customActionButtons.iterator();
            while (buttonsIter.hasNext())
            {
                remove(buttonsIter.next());
            }
            customActionButtons.clear();
        }

        if (customActionButtonsUIGroup != null
            && customActionButtonsUIGroup.size() > 0)
        {
            Iterator<JButton> buttonsIter =
                customActionButtonsUIGroup.iterator();
            while (buttonsIter.hasNext())
            {
                remove(buttonsIter.next());
            }
            customActionButtonsUIGroup.clear();
        }
    }

    /**
     * Initializes custom contact action buttons.
     *
     * @param contactActionButtons the list of buttons to initialize
     * @param gridX the X grid of the first button
     * @param xBounds the x bounds of the first button
     *
     * @return the new grid X coordinate after adding all the buttons
     */
    private int initGroupActionButtons(
        Collection<? extends JButton> contactActionButtons,
        int gridX,
        int xBounds)
    {
        // Reinit the labels to take the whole horizontal space.
        addLabels(gridX + contactActionButtons.size());

        Iterator<? extends JButton> actionsIter = contactActionButtons.iterator();
        while (actionsIter.hasNext())
        {
            final SIPCommButton actionButton = (SIPCommButton) actionsIter.next();

            // We need to explicitly remove the buttons from the tooltip manager,
            // because we're going to manager the tooltip ourselves in the
            // DefaultTreeContactList class. We need to do this in order to have
            // a different tooltip for every button and for non button area.
            ToolTipManager.sharedInstance().unregisterComponent(actionButton);

            if (customActionButtonsUIGroup == null)
                customActionButtonsUIGroup = new LinkedList<JButton>();

            customActionButtonsUIGroup.add(actionButton);

            xBounds
                += addButton(actionButton, ++gridX, xBounds, false, false);
        }

        return gridX;
    }

    /**
     * Initializes custom contact action buttons.
     *
     * @param contactActionButtons the list of buttons to initialize
     * @param gridX the X grid of the first button
     * @param xBounds the x bounds of the first button
     *
     * @return the new grid X coordiante after adding all the buttons
     */
    private int initContactActionButtons(
        Collection<? extends JButton> contactActionButtons,
        int gridX,
        int xBounds)
    {
        // Reinit the labels to take the whole horizontal space.
        addLabels(gridX + contactActionButtons.size());

        Iterator<? extends JButton> actionsIter = contactActionButtons.iterator();
        while (actionsIter.hasNext())
        {
            final SIPCommButton actionButton = (SIPCommButton) actionsIter.next();

            // We need to explicitly remove the buttons from the tooltip manager,
            // because we're going to manager the tooltip ourselves in the
            // DefaultTreeContactList class. We need to do this in order to have
            // a different tooltip for every button and for non button area.
            ToolTipManager.sharedInstance().unregisterComponent(actionButton);

            if (customActionButtons == null)
                customActionButtons = new LinkedList<JButton>();

            customActionButtons.add(actionButton);

            xBounds
                += addButton(actionButton, ++gridX, xBounds, false, true);
        }

        return gridX;
    }

    /**
     * Draw the icon at the specified location. Paints this component as an
     * icon.
     * @param c the component which can be used as observer
     * @param g the <tt>Graphics</tt> object used for painting
     * @param x the position on the X coordinate
     * @param y the position on the Y coordinate
     */
    public void paintIcon(Component c, Graphics g, int x, int y)
    {
        g = g.create();
        try
        {
            Graphics2D g2 = (Graphics2D) g;
            AntialiasingManager.activateAntialiasing(g2);

            g2.setColor(Color.WHITE);
            g2.setComposite(AlphaComposite.
                getInstance(AlphaComposite.SRC_OVER, 0.8f));
            g2.fillRoundRect(x, y,
                            getIconWidth() - 1, getIconHeight() - 1,
                            10, 10);
            g2.setColor(Color.DARK_GRAY);
            g2.drawRoundRect(x, y,
                            getIconWidth() - 1, getIconHeight() - 1,
                            10, 10);

            // Indent component content from the border.
            g2.translate(x + 5, y + 5);

            super.paint(g2);

            g2.translate(x, y);
        }
        finally
        {
            g.dispose();
        }
    }

    /**
     * Returns the call button contained in the current cell.
     * @return the call button contained in the current cell
     */
    public JButton getChatButton()
    {
        return chatButton;
    }

    /**
     * Returns the call button contained in the current cell.
     * @return the call button contained in the current cell
     */
    public JButton getCallButton()
    {
        return callButton;
    }

    /**
     * Returns the call video button contained in the current cell.
     * @return the call video button contained in the current cell
     */
    public JButton getCallVideoButton()
    {
        return callVideoButton;
    }

    /**
     * Returns the desktop sharing button contained in the current cell.
     * @return the desktop sharing button contained in the current cell
     */
    public JButton getDesktopSharingButton()
    {
        return desktopSharingButton;
    }

    /**
     * Returns the add contact button contained in the current cell.
     * @return the add contact button contained in the current cell
     */
    public JButton getAddContactButton()
    {
        return addContactButton;
    }

    /**
     * Calls the given treeNode.
     * @param treeNode the <tt>TreeNode</tt> to call
     */
    private void call(TreeNode treeNode, JButton button,
                      boolean isVideo, boolean isDesktopSharing)
    {
        if (!(treeNode instanceof ContactNode))
            return;

        UIContact contactDescriptor
            = ((ContactNode) treeNode).getContactDescriptor();

        Point location = new Point(button.getX(),
            button.getY() + button.getHeight());

        SwingUtilities.convertPointToScreen(location, treeContactList);

        location.y = location.y
            + treeContactList.getPathBounds(treeContactList.getSelectionPath()).y;
        location.x += 8;
        location.y -= 8;

        CallManager.call(contactDescriptor,
            isVideo, isDesktopSharing,
            treeContactList, location);
    }

    /**
     * Shows the appropriate user interface that would allow the user to add
     * the given <tt>SourceUIContact</tt> to their contact list.
     *
     * @param contact the contact to add
     */
    private void addContact(SourceUIContact contact)
    {
        SourceContact sourceContact = (SourceContact) contact.getDescriptor();

        List<ContactDetail> details = sourceContact.getContactDetails(
                    OperationSetPersistentPresence.class);
        int detailsCount = details.size();

        if (detailsCount > 1)
        {
            JMenuItem addContactMenu = TreeContactList.createAddContactMenu(
                (SourceContact) contact.getDescriptor());

            JPopupMenu popupMenu = ((JMenu) addContactMenu).getPopupMenu();

            // Add a title label.
            JLabel infoLabel = new JLabel();
            infoLabel.setText("<html><b>"
                                + GuiActivator.getResources()
                                    .getI18NString("service.gui.ADD_CONTACT")
                                + "</b></html>");

            popupMenu.insert(infoLabel, 0);
            popupMenu.insert(new Separator(), 1);

            popupMenu.setFocusable(true);
            popupMenu.setInvoker(treeContactList);

            Point location = new Point(addContactButton.getX(),
                addContactButton.getY() + addContactButton.getHeight());

            SwingUtilities.convertPointToScreen(location, treeContactList);

            location.y = location.y
                + treeContactList.getPathBounds(treeContactList.getSelectionPath()).y;

            popupMenu.setLocation(location.x + 8, location.y - 8);
            popupMenu.setVisible(true);
        }
        else if (details.size() == 1)
        {
            TreeContactList.showAddContactDialog(
                details.get(0),
                sourceContact.getDisplayName());
        }
    }

    /**
     * Returns the drag icon used to represent a cell in all drag operations.
     *
     * @param tree the parent tree object
     * @param dragObject the dragged object
     * @param index the index of the dragged object in the tree
     *
     * @return the drag icon
     */
    public Icon getDragIcon(JTree tree, Object dragObject, int index)
    {
        ContactListTreeCellRenderer dragC
            = (ContactListTreeCellRenderer) getTreeCellRendererComponent(
                                                        tree,
                                                        dragObject,
                                                        false, // is selected
                                                        false, // is expanded
                                                        true, // is leaf
                                                        index,
                                                        true // has focus
                                                     );

        // We should explicitly set the bounds of all components in order that
        // they're correctly painted by paintIcon afterwards. This fixes empty
        // drag component in contact list!
        dragC.setBounds(0, 0, dragC.getIconWidth(), dragC.getIconHeight());

        Icon rightLabelIcon = rightLabel.getIcon();
        int imageHeight = 0;
        int imageWidth = 0;
        if (rightLabelIcon != null)
        {
            imageWidth = rightLabelIcon.getIconWidth();
            imageHeight = rightLabelIcon.getIconHeight();
            dragC.rightLabel.setBounds(
                tree.getWidth() - imageWidth, 0, imageWidth, imageHeight);
        }

        dragC.statusLabel.setBounds(  0, 0,
                                statusLabel.getWidth(),
                                statusLabel.getHeight());

        dragC.nameLabel.setBounds(statusLabel.getWidth(), 0,
            tree.getWidth() - imageWidth - 5, nameLabel.getHeight());

        dragC.displayDetailsLabel.setBounds(
            displayDetailsLabel.getX(),
            nameLabel.getHeight(),
            displayDetailsLabel.getWidth(),
            displayDetailsLabel.getHeight());

        return dragC;
    }

    /**
     * Resets the rollover state of all rollover components in the current cell.
     */
    public void resetRolloverState()
    {
        chatButton.getModel().setRollover(false);
        callButton.getModel().setRollover(false);
        callVideoButton.getModel().setRollover(false);
        desktopSharingButton.getModel().setRollover(false);
        addContactButton.getModel().setRollover(false);
        webButton.getModel().setRollover(false);

        if (customActionButtons != null)
        {
            Iterator<JButton> buttonsIter = customActionButtons.iterator();
            while (buttonsIter.hasNext())
            {
                JButton button = buttonsIter.next();
                button.getModel().setRollover(false);
            }
        }

        if (customActionButtonsUIGroup != null)
        {
            Iterator<JButton> buttonsIter = customActionButtonsUIGroup.iterator();
            while (buttonsIter.hasNext())
            {
                JButton button = buttonsIter.next();
                button.getModel().setRollover(false);
            }
        }
    }

    /**
     * Resets the rollover state of all rollover components in the current cell
     * except the component given as a parameter.
     *
     * @param excludeComponent the component to exclude from the reset
     */
    public void resetRolloverState(Component excludeComponent)
    {
        if (!chatButton.equals(excludeComponent))
            chatButton.getModel().setRollover(false);

        if (!callButton.equals(excludeComponent))
            callButton.getModel().setRollover(false);

        if (!callVideoButton.equals(excludeComponent))
            callVideoButton.getModel().setRollover(false);

        if (!desktopSharingButton.equals(excludeComponent))
            desktopSharingButton.getModel().setRollover(false);

        if (!addContactButton.equals(excludeComponent))
            addContactButton.getModel().setRollover(false);

        if (!webButton.equals(excludeComponent))
            webButton.getModel().setRollover(false);

        if (customActionButtons != null)
        {
            Iterator<JButton> buttonsIter = customActionButtons.iterator();
            while (buttonsIter.hasNext())
            {
                JButton button = buttonsIter.next();

                if (!button.equals(excludeComponent))
                    button.getModel().setRollover(false);
            }
        }

        if (customActionButtonsUIGroup != null)
        {
            Iterator<JButton> buttonsIter =
                customActionButtonsUIGroup.iterator();
            while (buttonsIter.hasNext())
            {
                JButton button = buttonsIter.next();

                if (!button.equals(excludeComponent))
                    button.getModel().setRollover(false);
            }
        }
    }

    /**
     * Loads all images and colors.
     */
    public void loadSkin()
    {
        openedGroupIcon
            = new ImageIcon(ImageLoader.getImage(ImageLoader.OPENED_GROUP_ICON));

        closedGroupIcon
            = new ImageIcon(ImageLoader.getImage(ImageLoader.CLOSED_GROUP_ICON));

        callButton.setIconImage(ImageLoader.getImage(
                ImageLoader.CALL_BUTTON_SMALL));
        callButton.setRolloverIcon(ImageLoader.getImage(
                ImageLoader.CALL_BUTTON_SMALL_ROLLOVER));
        callButton.setPressedIcon(ImageLoader.getImage(
                ImageLoader.CALL_BUTTON_SMALL_PRESSED));

        chatButton.setIconImage(ImageLoader.getImage(
                ImageLoader.CHAT_BUTTON_SMALL));
        chatButton.setRolloverIcon(ImageLoader.getImage(
            ImageLoader.CHAT_BUTTON_SMALL_ROLLOVER));
        chatButton.setPressedIcon(ImageLoader.getImage(
                ImageLoader.CHAT_BUTTON_SMALL_PRESSED));

        msgReceivedImage
            = ImageLoader.getImage(ImageLoader.MESSAGE_RECEIVED_ICON);

        int groupForegroundProperty = GuiActivator.getResources()
            .getColor("service.gui.CONTACT_LIST_GROUP_FOREGROUND");

        if (groupForegroundProperty > -1)
            groupForegroundColor = new Color (groupForegroundProperty);

        int contactForegroundProperty = GuiActivator.getResources()
                .getColor("service.gui.CONTACT_LIST_CONTACT_FOREGROUND");

        if (contactForegroundProperty > -1)
            contactForegroundColor = new Color(contactForegroundProperty);

        callVideoButton.setIconImage(
            ImageLoader.getImage(ImageLoader.CALL_VIDEO_BUTTON_SMALL));
        callVideoButton.setRolloverIcon(
            ImageLoader.getImage(ImageLoader.CALL_VIDEO_BUTTON_SMALL_ROLLOVER));
        callVideoButton.setPressedIcon(
            ImageLoader.getImage(ImageLoader.CALL_VIDEO_BUTTON_SMALL_PRESSED));

        desktopSharingButton.setIconImage(
            ImageLoader.getImage(ImageLoader.DESKTOP_BUTTON_SMALL));
        desktopSharingButton.setRolloverIcon(
            ImageLoader.getImage(ImageLoader.DESKTOP_BUTTON_SMALL_ROLLOVER));
        desktopSharingButton.setPressedIcon(
            ImageLoader.getImage(ImageLoader.DESKTOP_BUTTON_SMALL_PRESSED));

        addContactButton.setIconImage(
            ImageLoader.getImage(ImageLoader.ADD_CONTACT_BUTTON_SMALL));
        addContactButton.setRolloverIcon(
            ImageLoader.getImage(ImageLoader.ADD_CONTACT_BUTTON_SMALL_ROLLOVER));
        addContactButton.setPressedIcon(
            ImageLoader.getImage(ImageLoader.ADD_CONTACT_BUTTON_SMALL_PRESSED));

        webButton.setIconImage(
            ImageLoader.getImage(ImageLoader.WEB_BUTTON));
        webButton.setRolloverIcon(
            ImageLoader.getImage(ImageLoader.WEB_BUTTON_ROLLOVER));
        webButton.setPressedIcon(
            ImageLoader.getImage(ImageLoader.WEB_BUTTON_PRESSED));
    }

    /**
     * Listens for contact details if not cached, we will receive when they
     * are retrieved to update current web button state, if meanwhile
     * user hasn't changed the current contact.
     */
    private class WebDetailsListener
        implements OperationSetServerStoredContactInfo.DetailsResponseListener
    {
        /**
         * The source this listener is created for, if current tree node
         * changes ignore any event.
         */
        private Object source;

        /**
         * The button to change.
         */
        private JButton webButton;

        /**
         * The ui contact to update after changes.
         */
        private UIContact uiContact;

        /**
         * Create listener.
         * @param source the contact this listener is for, if different
         *               than current ignore.
         * @param webButton
         * @param uiContact the contact to refresh
         */
        WebDetailsListener(Object source, JButton webButton, UIContact uiContact)
        {
            this.source = source;
            this.webButton = webButton;
            this.uiContact = uiContact;
        }

        /**
         * Details have been retrieved.
         * @param details the details retrieved if any.
         */
        public void detailsRetrieved(Iterator<GenericDetail> details)
        {
            // if treenode has changed ignore
            if(!source.equals(treeNode))
                return;

            while(details.hasNext())
            {
                GenericDetail d = details.next();

                if(d instanceof URLDetail)
                {
                    final URLDetail webd = (URLDetail)d;
                    if(webd.getDetailValue() != null)
                    {
                        SwingUtilities.invokeLater(new Runnable()
                        {
                            public void run()
                            {
                                webButton.setEnabled(true);

                                treeContactList.refreshContact(uiContact);
                            }
                        });

                        return;
                    }
                 }
            }
        }
    }

    /**
     * Retrieves all web page details for the supplied uiContact.
     * @param uiContact the contacts
     * @param webDetailsListener the listener to wait for details retrieval,
     *                           or null of we do not want to wait
     * @param returnFirst should we return after founding the first one,
     *                    used for check whether such detail exist
     * @return list of details or null if currently not available
     */
    private static List<URLDetail> getURLDetails(
        UIContact uiContact,
        WebDetailsListener webDetailsListener,
        boolean returnFirst)
    {
        Iterator<Contact> contacts
            = ((MetaContact)uiContact.getDescriptor())
                .getContactsForOperationSet(
                    OperationSetServerStoredContactInfo.class).iterator();

        List<URLDetail> res = new ArrayList<URLDetail>();

        boolean foundWebLink = false;
        while (contacts.hasNext())
        {
            Contact contact = contacts.next();
            OperationSetServerStoredContactInfo opset
                = contact.getProtocolProvider().getOperationSet(
                    OperationSetServerStoredContactInfo.class);

            Iterator<GenericDetail> iter = null;
            try
            {
                iter = opset.requestAllDetailsForContact(
                    contact, webDetailsListener);
            }
            catch(Throwable t)
            {}

            if(iter == null)
                continue;

            while(iter.hasNext())
            {
                GenericDetail d = iter.next();
                if(d instanceof URLDetail)
                {
                    final URLDetail webd = (URLDetail)d;
                    if(webd.getDetailValue() != null)
                    {
                        res.add(webd);

                        if(returnFirst)
                        {
                            foundWebLink = true;
                            break;
                        }
                    }
                }
            }

            if(returnFirst && foundWebLink)
                break;
        }

        if(returnFirst)
        {
            if(res.isEmpty())
                return null;
        }

        return res;
    }

    /**
     * Opens url, used from webButton.
     * @param treeContactList the contactlist component
     * @param treeNode the currently selected node
     * @param button the button that was clicked
     */
    private static void openURL(
        TreeContactList treeContactList, TreeNode treeNode, JButton button)
    {
        if (treeNode != null && treeNode instanceof ContactNode)
        {
            UIContact contactDescriptor
                = ((ContactNode) treeNode).getContactDescriptor();

            List<String> urlDetails = null;

            if (contactDescriptor instanceof MetaUIContact)
            {
                List<URLDetail> details =
                    getURLDetails(contactDescriptor, null, false);

                if(details == null)
                    return;

                urlDetails = new ArrayList<String>();

                Iterator<URLDetail> detailIterator = details.iterator();
                while(detailIterator.hasNext())
                {
                    final URLDetail wd = detailIterator.next();
                    urlDetails.add(wd.getDetailValue().toString());
                }
            }
            else if (contactDescriptor.getDescriptor()
                instanceof SourceContact)
            {
                SourceContact src =
                    (SourceContact)contactDescriptor.getDescriptor();
                try
                {
                    List<ContactDetail> cDetails  =
                        src.getContactDetails(ContactDetail.Category.Web);

                    if(cDetails == null)
                        return;

                    urlDetails = new ArrayList<String>();

                    for(ContactDetail det : cDetails)
                    {
                        urlDetails.add(det.getDetail());
                    }
                }
                catch(OperationNotSupportedException onse)
                {}
            }

            if(urlDetails == null)
                return;

            if(urlDetails.size() == 1)
            {
                GuiActivator.getBrowserLauncher().openURL(urlDetails.get(0));
            }
            else
            {
                Point location = new Point(button.getX(),
                    button.getY() + button.getHeight());

                SwingUtilities.convertPointToScreen(
                    location, treeContactList);

                location.y = location.y
                    + treeContactList.getPathBounds(
                            treeContactList.getSelectionPath()).y;
                location.x += 8;
                location.y -= 8;

                List<JMenuItem> items = new ArrayList<JMenuItem>();
                Iterator<String> detailIterator = urlDetails.iterator();
                while(detailIterator.hasNext())
                {
                    String url = detailIterator.next();

                    String displayStr = url;
                    // do not display too long links
                    if(displayStr.length() > 60)
                    {
                        displayStr = displayStr.substring(0, 60);
                        displayStr += "...";
                    }
                    final JMenuItem menuItem = new JMenuItem(displayStr);
                    menuItem.setName(url);
                    menuItem.setToolTipText(url);

                    menuItem.addActionListener(new ActionListener()
                    {
                        public void actionPerformed(ActionEvent e)
                        {
                            GuiActivator.getBrowserLauncher().openURL(
                                menuItem.getName());
                        }
                    });
                    items.add(menuItem);
                }

                new ExtendedPopupMenu(
                        treeContactList,
                        null,
                        items).showPopupMenu(location.x, location.y);
            }
        }
    }

    /**
     * Listens for contact details if not cached, we will receive when they
     * are retrieved to update current call button state, if meanwhile
     * user hasn't changed the current contact.
     */
    private class DetailsListener
        implements OperationSetServerStoredContactInfo.DetailsResponseListener
    {
        /**
         * The source this listener is created for, if current tree node
         * changes ignore any event.
         */
        private Object source;

        /**
         * The button to change.
         */
        private JButton callButton;

        /**
         * The ui contact to update after changes.
         */
        private UIContact uiContact;

        /**
         * Create listener.
         * @param source the contact this listener is for, if different
         *               than current ignore.
         * @param callButton
         * @param uiContact the contact to refresh
         */
        DetailsListener(Object source, JButton callButton, UIContact uiContact)
        {
            this.source = source;
            this.callButton = callButton;
            this.uiContact = uiContact;
        }

        /**
         * Details have been retrieved.
         * @param details the details retrieved if any.
         */
        public void detailsRetrieved(Iterator<GenericDetail> details)
        {
            // if treenode has changed ignore
            if(!source.equals(treeNode))
                return;

            while(details.hasNext())
            {
                GenericDetail d = details.next();

                if(d instanceof PhoneNumberDetail &&
                    !(d instanceof PagerDetail) &&
                    !(d instanceof FaxDetail))
                {
                    final PhoneNumberDetail pnd = (PhoneNumberDetail)d;
                    if(pnd.getNumber() != null &&
                        pnd.getNumber().length() > 0)
                    {
                        SwingUtilities.invokeLater(new Runnable()
                        {
                            public void run()
                            {
                                callButton.setEnabled(true);

                                if(pnd instanceof VideoDetail)
                                {
                                    callVideoButton.setEnabled(true);
                                    desktopSharingButton.setEnabled(true);
                                }

                                treeContactList.refreshContact(uiContact);
                            }
                        });

                        return;
                    }
                 }
            }
        }
    }

    /**
     * Adds button.
     * @param button the button to add
     * @param gridX the current x
     * @param xBounds bounds
     * @param isLast is it the last button
     * @param isContact is contact or <tt>false</tt> if it is group node, that
     * we are painting.
     * @return the button width.
     */
    private int addButton(  SIPCommButton button,
                            int gridX,
                            int xBounds,
                            boolean isLast,
                            boolean isContact)
    {
        lastAddedButton = button;

        constraints.insets = new Insets(0, 0, V_GAP, 0);
        constraints.anchor = GridBagConstraints.WEST;
        constraints.fill = GridBagConstraints.NONE;
        constraints.gridx = gridX;
        constraints.gridy = 2;
        constraints.gridwidth = 1;
        constraints.gridheight = 1;
        constraints.weightx = 0f;
        constraints.weighty = 0f;
        add(button, constraints);

        int yBounds = ComponentUtils.getStringSize(
                    nameLabel, nameLabel.getText()).height;

        if(isContact)
            yBounds += TOP_BORDER + BOTTOM_BORDER + 2*V_GAP
                + ComponentUtils.getStringSize(
                    displayDetailsLabel, displayDetailsLabel.getText()).height;

        button.setBounds(xBounds, yBounds, BUTTON_WIDTH, BUTTON_HEIGHT);

        button.setBorder(BorderFactory.createEmptyBorder(0, 0, 0, 0));

        setButtonBg(button, gridX, isLast);

        return button.getWidth();
    }

    /**
     * Sets the background of the button depending on its position in the button
     * bar.
     *
     * @param button the button which background to set
     * @param gridX the position of the button in the grid
     * @param isLast indicates if this is the last button in the button bar
     */
    private void setButtonBg(SIPCommButton button,
                            int gridX,
                            boolean isLast)
    {
        if (!isLast)
        {
            if (gridX == 1)
                button.setBackgroundImage(ImageLoader.getImage(
                    ImageLoader.CONTACT_LIST_BUTTON_BG_LEFT));
            else if (gridX > 1)
                button.setBackgroundImage(ImageLoader.getImage(
                    ImageLoader.CONTACT_LIST_BUTTON_BG_MIDDLE));
        }
        else
        {
            if (gridX == 1) // We have only one button shown.
                button.setBackgroundImage(ImageLoader.getImage(
                    ImageLoader.CONTACT_LIST_ONE_BUTTON_BG));
            else // We set the background of the last button in the toolbar
                button.setBackgroundImage(ImageLoader.getImage(
                    ImageLoader.CONTACT_LIST_BUTTON_BG_RIGHT));
        }
    }

    /**
     * Sets the correct border depending on the contained object.
     */
    private void setBorder()
    {
        /*
         * !!! When changing border values we should make sure that we
         * recalculate the X and Y coordinates of the buttons added in
         * initButtonsPanel and initContactActionButtons functions. If not
         * correctly calculated problems may occur when clicking buttons!
         */
        if (treeNode instanceof ContactNode
                && !(((ContactNode) treeNode).getContactDescriptor() instanceof
                        ShowMoreContact))
        {
            setBorder(
                    BorderFactory.createEmptyBorder(
                            TOP_BORDER,
                            LEFT_BORDER,
                            BOTTOM_BORDER,
                            RIGHT_BORDER));
        }
        else // GroupNode || ShowMoreContact
        {
            setBorder(
                    BorderFactory.createEmptyBorder(
                            0,
                            LEFT_BORDER,
                            0,
                            RIGHT_BORDER));
        }
    }

    /**
     * Inializes button tool tips.
     */
    private void initButtonToolTips()
    {
        callButton.setToolTipText(GuiActivator.getResources()
            .getI18NString("service.gui.CALL_CONTACT"));
        callVideoButton.setToolTipText(GuiActivator.getResources()
            .getI18NString("service.gui.VIDEO_CALL"));
        desktopSharingButton.setToolTipText(GuiActivator.getResources()
            .getI18NString("service.gui.SHARE_DESKTOP"));
        chatButton.setToolTipText(GuiActivator.getResources()
            .getI18NString("service.gui.SEND_MESSAGE"));
        addContactButton.setToolTipText(GuiActivator.getResources()
            .getI18NString("service.gui.ADD_CONTACT"));
        webButton.setToolTipText(GuiActivator.getResources()
            .getI18NString("service.gui.WEBPAGE"));

        // We need to explicitly remove the buttons from the tooltip manager,
        // because we're going to manager the tooltip ourselves in the
        // DefaultTreeContactList class. We need to do this in order to have
        // a different tooltip for every button and for non button area.
        ToolTipManager ttManager = ToolTipManager.sharedInstance();
        ttManager.unregisterComponent(callButton);
        ttManager.unregisterComponent(callVideoButton);
        ttManager.unregisterComponent(desktopSharingButton);
        ttManager.unregisterComponent(chatButton);
        ttManager.unregisterComponent(addContactButton);
        ttManager.unregisterComponent(webButton);
    }

    /**
     * Web button contains one or several links that can be opened in default
     * browser if clicked.
     */
    private class WebButton
        extends SIPCommButton
    {
        /**
         * The links used in this button.
         */
        private List<String> links;

        /**
         * Changes the links.
         * @param links
         */
        private void setLinksFromURLDetail(List<URLDetail> links)
        {
            this.links = new ArrayList<String>();
            for(URLDetail l : links)
                this.links.add(l.getDetailValue().toString());
        }

        /**
         * Changes the links.
         * @param links
         */
        private void setLinksFromContactDetail(List<ContactDetail> links)
        {
            this.links = new ArrayList<String>();
            for(ContactDetail l : links)
                this.links.add(l.getDetail());
        }

        /**
         * Clear links.
         */
        private void clearLinks()
        {
            links = null;
        }

        /**
         * Returns the custom tooltip.
         * @returns the custom tooltip.
         */
        public ExtendedTooltip getTooltip()
        {
            if(links == null)
                return null;

            // create a custom button tooltip to show the available links
            ExtendedTooltip tip = new ExtendedTooltip(true);
            tip.setTitle(webButton.getToolTipText());

            for(String displayStr : links)
            {
                // do not display too long links
                if(displayStr.length() > 60)
                {
                    displayStr = displayStr.substring(0, 60);
                    displayStr += "...";
                }
                tip.addLine(null, displayStr);
            }

            return tip;
        }
    }
}