to.etc.domui.annotations
Annotation Type UIMenu


@Target(value=TYPE)
@Retention(value=RUNTIME)
public @interface UIMenu

When present on an UrlPage, this defines the basic data that is needed to have the page be accessible from a menu. This can be used to maintain menu data close to a page. All texts accessed herein

Author:
Frits Jalvingh Created on Apr 3, 2009

Optional Element Summary
 java.lang.String baseKey
          The base for a key to use for finding the subitems; this base is used and .title, .label, .search gets added to it.
 java.lang.Class<?> bundleBase
          Used to override the default location for the message file.
 java.lang.String bundleName
          The name of the message bundle defining the texts for this entry.
 java.lang.String descKey
          Defines the bundle key for a short description of this page, to be used in the menu.
 java.lang.Class<?> iconBase
          When present this indicates that the icon is a classpath resource.
 java.lang.String iconName
          The application-relative URL of the icon that should be used to show on the menu entry and the title bar.
 java.lang.String labelKey
          The key describing the menu label for this page.
 java.lang.String menuID
          The unique ID for this page in the menu.
 java.lang.String searchKey
          Defines the bundle key for the set of keywords to search for this item.
 java.lang.String titleKey
          The bundle key for the page title.
 

bundleBase

public abstract java.lang.Class<?> bundleBase
Used to override the default location for the message file. The class from where we lookup the bundle by name

Default:
java.lang.Object.class

bundleName

public abstract java.lang.String bundleName
The name of the message bundle defining the texts for this entry. When it is needed but not set the name defaults to "messages".

Default:
""

baseKey

public abstract java.lang.String baseKey
The base for a key to use for finding the subitems; this base is used and .title, .label, .search gets added to it.

Default:
""

menuID

public abstract java.lang.String menuID
The unique ID for this page in the menu. If not present the page name will be used as a menu ID.

Default:
""

titleKey

public abstract java.lang.String titleKey
The bundle key for the page title. This decides the page title in the PageBar, and if labelKey is empty it also defines the menu's label.

Default:
""

searchKey

public abstract java.lang.String searchKey
Defines the bundle key for the set of keywords to search for this item.

Default:
""

descKey

public abstract java.lang.String descKey
Defines the bundle key for a short description of this page, to be used in the menu.

Default:
""

labelKey

public abstract java.lang.String labelKey
The key describing the menu label for this page.

Default:
""

iconName

public abstract java.lang.String iconName
The application-relative URL of the icon that should be used to show on the menu entry and the title bar. If an iconBase is present this name is treated as a classpath resource starting at the base class specified.

Default:
""

iconBase

public abstract java.lang.Class<?> iconBase
When present this indicates that the icon is a classpath resource. The name is looked up relative to this class.

Default:
java.lang.Object.class