com.ptc.windchill.enterprise.object.dataUtilities
Class AbstractMailToDataUtility

java.lang.Object
  com.ptc.core.components.factory.AbstractDataUtility
      com.ptc.core.components.factory.dataUtilities.AbstractAttributeDataUtility
          com.ptc.windchill.enterprise.object.dataUtilities.AbstractMailToDataUtility

All Implemented Interfaces:

com.ptc.core.components.descriptor.DataUtility, com.ptc.core.components.descriptor.GuiComponentFactory, com.ptc.core.components.factory.dataUtilities.AttributeGuiComponentFactory

public abstract class AbstractMailToDataUtility
extends com.ptc.core.components.factory.dataUtilities.AbstractAttributeDataUtility

Abstract data utility for icon columns whereby a mailto link is generated. The actually participants and the tooltip text is determined by the implementing class.

Supported API: true

Method Summary

Object	getDataValue(String component_id, Object datum, com.ptc.core.components.descriptor.ModelContext mc) Returns the IconComponent for the mailto link or null if not applicable.
abstract List<WTPrincipalReference>	getParticipants(Object obj) Retrieve the participant email for the object.
abstract String	getTooltip(List<WTPrincipalReference> refs) Generate a tooltip from the list of WTPrincipalReferences used by the mailto icon.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getParticipants

public abstract List<WTPrincipalReference> getParticipants(Object obj)

Retrieve the participant email for the object. A value of null should be returned if there is no email present.

Supported API: true

Parameters:

obj - The object to retrieve the email for.

Returns:

String The email as specified by the implementing class.

getTooltip

public abstract String getTooltip(List<WTPrincipalReference> refs)

Generate a tooltip from the list of WTPrincipalReferences used by the mailto icon. This should return "" if there is no tooltip.

Supported API: true

Parameters:

refs - The references to generate the tooltip from.

Returns:

String

getDataValue

public Object getDataValue(String component_id,
                           Object datum,
                           com.ptc.core.components.descriptor.ModelContext mc)
                    throws WTException

Returns the IconComponent for the mailto link or null if not applicable.
Current supported objects: Element

Supported API: true

Overrides:

getDataValue in class com.ptc.core.components.factory.dataUtilities.AbstractAttributeDataUtility

Parameters:

component_id - The string component_id

datum - The object for which to generate the mailto link for.

mc - The model context.

Returns:

Object the icon component for the mailto link.

Throws:

WTException