com.gwtplatform.mvp.client.annotations

Annotation Type TabInfo

@Target(value={TYPE,METHOD})
public @interface TabInfo

Annotation used to specify various information on a tab. The container() parameter is mandatory. This annotation can be used in one of three ways:

1) Annotating the proxy
You can directly annotate your proxy with it, in which case the label() parameter must be specified. For example:

 @ProxyCodeSplit
 @NameToken("HOME")
 @TabInfo(
    container = TabStripPresenter.class,
    priority = 0,
    label = "Home Page" )
 public interface MyProxy extends TabContentProxyPlace<HomeTabPresenter> { }

If this presenter is not a place then you also need to specify the nameToken() parameter. This is useful for setting up nested tab panels, for example:

 @ProxyCodeSplit
 @TabInfo(
    container = TabStripPresenter.class,
    priority = 1,
    nameToken = "SETTINGS-USER")
 public interface MyProxy extends TabContentProxy<SettingsTabStripPresenter> { }
 

2) Annotating a static method returning String
You can annotate a static method returning a String, in which case you must not specify the label(). Again, specify the nameToken() parameter only if your presenter is not a place.

The method you annotate can optionally accept exactly 1 parameter having the type of your custom Ginjector. Here's an example of this usage:

 @ProxyCodeSplit
 @NameToken("HOME")
 public interface MyProxy extends TabContentProxyPlace<HomeTabPresenter> { }

 @TabInfo(
    container = TabStripPresenter.class,
    priority = 0 )
 static String getLabel(MyGingector ginjector) {
   return gingector.getTranslations().homePageLabel();
 }
 

3) Annotating a static method returning TabData
You can annotate a static method returning a TabData, in which case you must not specify either the label() nor the priority(). Again, specify the nameToken() parameter only if your presenter is not a place.

The method you annotate can optionally accept parameters having either the type of your custom Ginjector or any type that is provided by the ginjector. Here are two examples of this usage:

 @ProxyCodeSplit
 public interface MyProxy extends TabContentProxy<SettingsTabStripPresenter> { }

 @TabInfo(
    container = TabStripPresenter.class,
    priority = 1,
    nameToken = "SETTINGS-USER")
 static TabData getTabData(MyGingector ginjector) {
   return ginjector.getTabDataFactory().createUserTabData();
 }
 

 @TabInfo(container = ApplicationPresenter.class)
 static TabData getTabData(Messages msgs, IsAdminGateKeeper keeper) {
   return new TabDataExt(msgs.adminTitle(), 1000, keeper);;
 }
 

Author:

Philippe Beaudoin

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class<? extends TabContainerPresenter<?,?>>	container This parameter indicates the presenter into which this tab will be displayed.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	label A static string corresponding to the label to display on the tab.
String	nameToken The name token indicates which place should be visited when you click on this tab.
int	priority The priority is a non-negative integer that controls the order in which tabs are displayed.

Element Detail

container

public abstract Class<? extends TabContainerPresenter<?,?>> container

This parameter indicates the presenter into which this tab will be displayed. Typically, the container will contain a tab strip and this tab will be displayed in it.

Returns:

The container presenter.

label

public abstract String label

A static string corresponding to the label to display on the tab. For more flexibility, see other ways to use the TabInfo annotation.

Returns:

The label.

Default:

""

priority

public abstract int priority

The priority is a non-negative integer that controls the order in which tabs are displayed. For more information see TabData.getPriority().

Returns:

The priority, or a negative integer if not set.

Default:

-1

nameToken

public abstract String nameToken

The name token indicates which place should be visited when you click on this tab. You should only specify this if your presenter is not a place. For example, if it is a tab panel meant to be contained in another tab panel.

Returns:

The name token.

Default:

""