/**
* 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<SIPCommButton> contactActionButtons, int gridX, int xBounds) {
// Reinit the labels to take the whole horizontal space.
addLabels(gridX + contactActionButtons.size());
Iterator<SIPCommButton> actionsIter = contactActionButtons.iterator();
while (actionsIter.hasNext()) {
final SIPCommButton actionButton = 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);
}
return gridX;
}
/**
* Adds resources for contact.
*
* @param tip the tool tip
* @param protocolContact the protocol contact, which resources we're looking for
*/
private void addContactResourceTooltipLines(ExtendedTooltip tip, Contact protocolContact) {
Collection<ContactResource> contactResources = protocolContact.getResources();
if (contactResources == null) return;
Iterator<ContactResource> resourcesIter = contactResources.iterator();
while (resourcesIter.hasNext()) {
ContactResource contactResource = resourcesIter.next();
// We only add the status icon if we have more than one resources,
// otherwise it will always be identical to the contact status icon.
ImageIcon protocolStatusIcon = null;
if (contactResources.size() > 1) {
protocolStatusIcon =
ImageLoader.getIndexedProtocolIcon(
ImageUtils.getBytesInImage(contactResource.getPresenceStatus().getStatusIcon()),
protocolContact.getProtocolProvider());
}
String resourceName =
(contactResource.getPriority() >= 0)
? contactResource.getResourceName() + " (" + contactResource.getPriority() + ")"
: contactResource.getResourceName();
if (protocolStatusIcon == null) tip.addSubLine(protocolStatusIcon, resourceName, 27);
else tip.addSubLine(protocolStatusIcon, resourceName, 20);
}
tip.revalidate();
tip.repaint();
}
/**
* 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;
}
}
}
}
/**
* Fills the tooltip with details.
*
* @param tip the tooltip to fill
* @param phones the available phone details.
*/
private void addPhoneTooltipLines(ExtendedTooltip tip, Iterator<String> phones) {
while (phones.hasNext()) {
tip.addSubLine(null, phones.next(), 27);
}
tip.revalidate();
tip.repaint();
}
/**
* Returns a list of all <tt>UIContactDetail</tt>s within this <tt>UIContact</tt>.
*
* @return a list of all <tt>UIContactDetail</tt>s within this <tt>UIContact</tt>
*/
public List<UIContactDetail> getContactDetails() {
List<UIContactDetail> resultList = new LinkedList<UIContactDetail>();
Iterator<Contact> contacts = metaContact.getContacts();
while (contacts.hasNext()) {
resultList.add(new MetaContactDetail(contacts.next()));
}
return resultList;
}
/** Initializes all search strings for this <tt>MetaUIGroup</tt>. */
private void initSearchStrings() {
searchStrings.add(metaContact.getDisplayName());
Iterator<Contact> contacts = metaContact.getContacts();
while (contacts.hasNext()) {
Contact contact = contacts.next();
searchStrings.add(contact.getDisplayName());
searchStrings.add(contact.getAddress());
}
}
/**
* Returns a list of <tt>UIContactDetail</tt>s supporting the given <tt>OperationSet</tt> class.
*
* @param opSetClass the <tt>OperationSet</tt> class we're interested in
* @return a list of <tt>UIContactDetail</tt>s supporting the given <tt>OperationSet</tt> class
*/
public List<UIContactDetail> getContactDetailsForOperationSet(
Class<? extends OperationSet> opSetClass) {
List<UIContactDetail> resultList = new LinkedList<UIContactDetail>();
Iterator<Contact> contacts = metaContact.getContactsForOperationSet(opSetClass).iterator();
while (contacts.hasNext()) {
resultList.add(new MetaContactDetail(contacts.next()));
}
return resultList;
}
/**
* Returns the general status icon of the given MetaContact. Detects the status using the priority
* status table. The priority is defined on the "availability" factor and here the most
* "available" status is returned.
*
* @return PresenceStatus The most "available" status from all sub-contact statuses.
*/
public ImageIcon getStatusIcon() {
PresenceStatus status = null;
Iterator<Contact> i = metaContact.getContacts();
while (i.hasNext()) {
Contact protoContact = i.next();
PresenceStatus contactStatus = protoContact.getPresenceStatus();
if (status == null) status = contactStatus;
else status = (contactStatus.compareTo(status) > 0) ? contactStatus : status;
}
if (status != null) return new ImageIcon(Constants.getStatusIcon(status));
return null;
}
/**
* Returns the display details for the underlying <tt>MetaContact</tt>.
*
* @return the display details for the underlying <tt>MetaContact</tt>
*/
public String getDisplayDetails() {
String displayDetails = null;
Iterator<Contact> protoContacts = metaContact.getContacts();
String subscriptionDetails = null;
while (protoContacts.hasNext()) {
Contact protoContact = protoContacts.next();
OperationSetExtendedAuthorizations authOpSet =
protoContact
.getProtocolProvider()
.getOperationSet(OperationSetExtendedAuthorizations.class);
if (authOpSet != null
&& authOpSet.getSubscriptionStatus(protoContact) != null
&& !authOpSet.getSubscriptionStatus(protoContact).equals(SubscriptionStatus.Subscribed)) {
SubscriptionStatus status = authOpSet.getSubscriptionStatus(protoContact);
if (status.equals(SubscriptionStatus.SubscriptionPending))
subscriptionDetails =
GuiActivator.getResources().getI18NString("service.gui.WAITING_AUTHORIZATION");
else if (status.equals(SubscriptionStatus.NotSubscribed))
subscriptionDetails =
GuiActivator.getResources().getI18NString("service.gui.NOT_AUTHORIZED");
} else if (protoContact.getStatusMessage() != null
&& protoContact.getStatusMessage().length() > 0) {
subscribed = true;
displayDetails = protoContact.getStatusMessage();
break;
} else {
subscribed = true;
}
}
if ((displayDetails == null || displayDetails.length() <= 0)
&& !subscribed
&& subscriptionDetails != null
&& subscriptionDetails.length() > 0) displayDetails = subscriptionDetails;
return displayDetails;
}
/**
* Searches for additional phone numbers found in contact information
*
* @return additional phone numbers found in contact information;
*/
private List<UIContactDetail> getAdditionalNumbers(boolean onlyMobile) {
List<UIContactDetail> telephonyContacts = new ArrayList<UIContactDetail>();
Iterator<Contact> contacts = getMetaContact().getContacts();
while (contacts.hasNext()) {
Contact contact = contacts.next();
OperationSetServerStoredContactInfo infoOpSet =
contact.getProtocolProvider().getOperationSet(OperationSetServerStoredContactInfo.class);
Iterator<GenericDetail> details;
ArrayList<String> phones = new ArrayList<String>();
if (infoOpSet != null) {
details = infoOpSet.getAllDetailsForContact(contact);
while (details.hasNext()) {
GenericDetail d = details.next();
boolean process = false;
if (onlyMobile) {
if (d instanceof MobilePhoneDetail) process = true;
} else if (d instanceof PhoneNumberDetail
&& !(d instanceof PagerDetail)
&& !(d instanceof FaxDetail)) {
process = true;
}
if (process) {
PhoneNumberDetail pnd = (PhoneNumberDetail) d;
if (pnd.getNumber() != null && pnd.getNumber().length() > 0) {
// skip phones which were already added
if (phones.contains(pnd.getNumber())) continue;
phones.add(pnd.getNumber());
UIContactDetail cd =
new UIContactDetailImpl(
pnd.getNumber(),
pnd.getNumber() + " (" + getLocalizedPhoneNumber(d) + ")",
null,
new ArrayList<String>(),
GuiActivator.getResources().getImage("service.gui.icons.EXTERNAL_PHONE"),
null,
null,
pnd) {
@Override
public PresenceStatus getPresenceStatus() {
return null;
}
};
telephonyContacts.add(cd);
}
}
}
}
}
return telephonyContacts;
}
/**
* 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 (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);
}
}
}
/**
* Returns the display name of this <tt>MetaUIContact</tt>.
*
* @return the display name of this <tt>MetaUIContact</tt>
*/
public String getDisplayName() {
String displayName = metaContact.getDisplayName();
/*
* If the MetaContact doesn't tell us a display name, make up a display
* name so that we don't end up with "Unknown user".
*/
if ((displayName == null) || (displayName.trim().length() == 0)) {
/*
* Try to get a display name from one of the Contacts of the
* MetaContact. If that doesn't cut it, use the address of a
* Contact. Because it's not really clear which address to display
* when there are multiple Contacts, use the address only when
* there's a single Contact in the MetaContact.
*/
Iterator<Contact> contactIter = metaContact.getContacts();
int contactCount = 0;
String address = null;
while (contactIter.hasNext()) {
Contact contact = contactIter.next();
contactCount++;
displayName = contact.getDisplayName();
if ((displayName == null) || (displayName.trim().length() == 0)) {
/*
* As said earlier, only use an address if there's a single
* Contact in the MetaContact.
*/
address = (contactCount == 1) ? contact.getAddress() : null;
} else break;
}
if ((address != null)
&& (address.trim().length() != 0)
&& ((displayName == null) || (displayName.trim().length() == 0))) displayName = address;
}
return displayName;
}
/** 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();
}
}
/** 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);
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);
}
}
}
/**
* Loads the tooltip with the data for current metacontact.
*
* @param tip the tooltip to fill.
*/
private void loadTooltip(final ExtendedTooltip tip) {
Iterator<Contact> i = metaContact.getContacts();
ContactPhoneUtil contactPhoneUtil = ContactPhoneUtil.getPhoneUtil(metaContact);
String statusMessage = null;
Contact protocolContact;
boolean isLoading = false;
while (i.hasNext()) {
protocolContact = i.next();
// Set the first found status message.
if (statusMessage == null
&& protocolContact.getStatusMessage() != null
&& protocolContact.getStatusMessage().length() > 0)
statusMessage = protocolContact.getStatusMessage();
if (ConfigurationUtils.isHideAccountStatusSelectorsEnabled()) break;
ImageIcon protocolStatusIcon =
ImageLoader.getIndexedProtocolIcon(
ImageUtils.getBytesInImage(protocolContact.getPresenceStatus().getStatusIcon()),
protocolContact.getProtocolProvider());
String contactAddress = protocolContact.getAddress();
// String statusMessage = protocolContact.getStatusMessage();
tip.addLine(protocolStatusIcon, contactAddress);
addContactResourceTooltipLines(tip, protocolContact);
if (!protocolContact.getProtocolProvider().isRegistered()) continue;
contactPhoneUtil.addDetailsResponseListener(
protocolContact,
new OperationSetServerStoredContactInfo.DetailsResponseListener() {
public void detailsRetrieved(final Iterator<GenericDetail> details) {
if (!SwingUtilities.isEventDispatchThread()) {
SwingUtilities.invokeLater(
new Runnable() {
public void run() {
detailsRetrieved(details);
}
});
return;
}
// remove previously shown information
// as it contains "Loading..." text
tip.removeAllLines();
// load it again
loadTooltip(tip);
}
});
List<String> phones = contactPhoneUtil.getPhones(protocolContact);
if (phones != null) {
addPhoneTooltipLines(tip, phones.iterator());
} else isLoading = true;
}
if (isLoading)
tip.addLine(null, GuiActivator.getResources().getI18NString("service.gui.LOADING"));
if (statusMessage != null) tip.setBottomText(statusMessage);
}
/**
* Initializes buttons panel.
*
* @param uiContact the <tt>UIContact</tt> for which we initialize the button panel
*/
private void initButtonsPanel(UIContact uiContact) {
this.remove(chatButton);
this.remove(callButton);
this.remove(callVideoButton);
this.remove(desktopSharingButton);
this.remove(addContactButton);
clearCustomActionButtons();
if (!isSelected) return;
UIContactDetail imContact = null;
// For now we support instance messaging only for contacts in our
// contact list until it's implemented for external source contacts.
if (uiContact.getDescriptor() instanceof MetaContact)
imContact = uiContact.getDefaultContactDetail(OperationSetBasicInstantMessaging.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);
}
UIContactDetail telephonyContact =
uiContact.getDefaultContactDetail(OperationSetBasicTelephony.class);
// Check if contact has additional phone numbers, if yes show the
// call button
ContactPhoneUtil contactPhoneUtil = 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 = ContactPhoneUtil.getPhoneUtil((MetaContact) uiContact.getDescriptor());
MetaContact metaContact = (MetaContact) uiContact.getDescriptor();
Iterator<Contact> contacts = metaContact.getContacts();
while (contacts.hasNext()) // && !hasPhone)
{
Contact contact = contacts.next();
if (!contact.getProtocolProvider().isRegistered()) continue;
contactPhoneUtil.addDetailsResponseListener(
contact, 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() && providers.size() > 0)) {
x += addButton(callButton, ++gridX, x, false);
}
UIContactDetail videoContact =
uiContact.getDefaultContactDetail(OperationSetVideoTelephony.class);
if (videoContact != null
|| (contactPhoneUtil != null && contactPhoneUtil.isVideoCallEnabled())) {
x += addButton(callVideoButton, ++gridX, x, false);
}
UIContactDetail desktopContact =
uiContact.getDefaultContactDetail(OperationSetDesktopSharingServer.class);
if (desktopContact != null
|| (contactPhoneUtil != null && contactPhoneUtil.isDesktopSharingEnabled())) {
x += addButton(desktopSharingButton, ++gridX, x, false);
}
// 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);
}
// The list of the contact actions
// we will create a button for every action
Collection<SIPCommButton> 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);
this.setBounds(0, 0, treeContactList.getWidth(), getPreferredSize().height);
}
