Package com.novomind.ecom.api.imail.common.frontend.mailinfo

Class MailInfoTab

java.lang.Object

com.novomind.ecom.api.iagent.frontend.tab.AbstractTab

com.novomind.ecom.api.imail.common.frontend.mailinfo.MailInfoTab

All Implemented Interfaces:

InfoTab, Tab, com.novomind.ecom.common.api.attribute.DisplayNamed, com.novomind.ecom.common.api.attribute.Named

public final class MailInfoTab
extends AbstractTab
implements InfoTab

Instances of this class are used as return values of MailInfoTabProvider to define and display custom tabs in the mail info view (Supervisor and Agent)

Since:

10.0.16

Field Summary

Fields inherited from class com.novomind.ecom.api.iagent.frontend.tab.AbstractTab

displayName, name, url

Constructor Summary

Constructors

Constructor	Description
MailInfoTab(String name, String displayName, String url)	Initializes a newly created MailInfoTab

Method Summary

Modifier and Type	Method	Description
InfoTabBehavior	getBehavior()	The behavior of the InfoTab when the tab's parent view is being rendered.
MailInfoTab	setBehavior(InfoTabBehavior behavior)	Sets the behavior of the InfoTab when the tab's parent view is being rendered.
String	toString()

Methods inherited from class com.novomind.ecom.api.iagent.frontend.tab.AbstractTab

getDisplayName, getName, getUrl

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.novomind.ecom.common.api.attribute.DisplayNamed

getDisplayName

Methods inherited from interface com.novomind.ecom.common.api.attribute.Named

getName

Methods inherited from interface com.novomind.ecom.api.iagent.frontend.tab.Tab

getUrl

Constructor Details

MailInfoTab

public MailInfoTab(String name,
 String displayName,
 String url)

Initializes a newly created MailInfoTab

Parameters:

name - The unique name of the mail info tab

displayName - The name to be displayed at the top of the mail info tab

url - The url to be loaded and displayed within the iframe of the mail info tab (Please note that relative URLs must be provided as result of MailInfoViewContext.getViewUrl(String url)) Example:

         public class HelloWorldMailInfoTab implements MailInfoTabProvider {
           @Override
           public MailInfoTab getMailInfoTab(MailInfoViewContext context) {
             return new MailInfoTab(name, displayName, context.getViewUrl("/mailinfo/helloworld/helloWorld.xhtml"));
           }
         }
         

Since:

10.0.16

Method Details

setBehavior

public MailInfoTab setBehavior(InfoTabBehavior behavior)

Sets the behavior of the InfoTab when the tab's parent view is being rendered.

Parameters:

behavior - The behavior of the InfoTab when the tab's parent view is being rendered.

Returns:

this

Since:

10.0.28

getBehavior

public InfoTabBehavior getBehavior()

Description copied from interface: InfoTab

The behavior of the InfoTab when the tab's parent view is being rendered.

Specified by:

getBehavior in interface InfoTab

Returns:

the InfoTabBehavior

Since:

10.0.28

toString

public String toString()

Overrides:

toString in class AbstractTab

Since:

10.0.16