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

Class 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 java.lang.Object
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

    • Constructor Summary

      Constructors 
      Constructor Description
      MailInfoTab​(java.lang.String name, java.lang.String displayName, java.lang.String url)
      Initializes a newly created MailInfoTab

    • Constructor Detail

      • MailInfoTab

        public MailInfoTab​(java.lang.String name,
                   java.lang.String displayName,
                   java.lang.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 Detail

      • getName

        public java.lang.String getName()
        Specified by:
        getName in interface com.novomind.ecom.common.api.attribute.Named
        Since:
        10.0.16

      • getDisplayName

        public java.lang.String getDisplayName()
        Specified by:
        getDisplayName in interface com.novomind.ecom.common.api.attribute.DisplayNamed
        Since:
        10.0.16

      • getUrl

        public java.lang.String getUrl()
        Description copied from interface: Tab
        The URL of the tab's content
        Specified by:
        getUrl in interface Tab
        Returns:
        the URL as String
        Since:
        10.0.16

      • setBehavior

        public MailInfoTab setBehavior​(InfoTabBehavior behavior)
        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 java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        Since:
        10.0.16