View Javadoc

1   package com.atlassian.plugin.web.descriptors;
2   
3   import com.atlassian.plugin.web.model.WebIcon;
4   import com.atlassian.plugin.web.model.WebLink;
5   
6   /**
7    * A web-item plugin adds extra links to a particular section.
8    *
9    * @see WebSectionModuleDescriptor
10   */
11  public interface WebItemModuleDescriptor extends WebFragmentModuleDescriptor
12  {
13      String getSection();
14  
15      WebLink getLink();
16  
17      WebIcon getIcon();
18  
19      /**
20       * Returns the item style as a "class" String consisting of one or more style classes.
21       * The default value returned should be an empty String rather than null.
22       * <p>
23       * Where possible, use of this method is preferred over <code>getIcon</code> as it
24       * allows more flexibility for CSS-based web element styling and class-based
25       * JavaScript behaviour.
26       *
27       * @return space-separated list of style classes
28       */
29      String getStyleClass();
30  }