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

Class MessageTab

  • All Implemented Interfaces:
    Tab, com.novomind.ecom.common.api.attribute.DisplayNamed, com.novomind.ecom.common.api.attribute.Named
    public final class MessageTab
extends java.lang.Object
implements Tab
    Since:
    10.0.132

    • Constructor Summary

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDisplayName()  
      java.lang.String getName()  
      java.lang.String getUrl()
      The URL of the tab's content
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • MessageTab

        public MessageTab​(java.lang.String displayName,
                  java.lang.String url)
        Initializes a newly created MessageTab
        Parameters:
        displayName - The name to be displayed at the top of the message tab
        url - The url to be loaded and displayed within the iframe of the message tab (Please note that relative URLs must be provided as result of MessageViewContext.getViewUrl(String url)) Example: 
                 public class HelloWorldMessageTab implements MessageTabProvider {
           @Override
           public MessageTab getMessageTab(IncomingMessageViewContext context) {
             return new MessageTab(displayName, context.getViewUrl("/message/helloworld/helloWorld.xhtml"));
           }
         }
        Since:
        10.0.132

    • Method Detail

      • getName

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

      • getDisplayName

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

      • 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.132

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        Since:
        10.0.132