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

Optional Elements

Modifier and Type	Optional Element and Description
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.
Class<?>	bundleBase Used to override the default location for the message file.
String	bundleName The name of the message bundle defining the texts for this entry.
String	descKey Defines the bundle key for a short description of this page, to be used in the menu.
Class<?>	iconBase When present this indicates that the icon is a classpath resource.
String	iconName The application-relative URL of the icon that should be used to show on the menu entry and the title bar.
String	labelKey The key describing the menu label for this page.
String	menuID The unique ID for this page in the menu.
String	searchKey Defines the bundle key for the set of keywords to search for this item.
String	titleKey The bundle key for the page title.

Element Detail

bundleBase

public abstract 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 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 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 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 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 String searchKey

Defines the bundle key for the set of keywords to search for this item.

Default:

""

descKey

public abstract String descKey

Defines the bundle key for a short description of this page, to be used in the menu.

Default:

""

labelKey

public abstract String labelKey

The key describing the menu label for this page.

Default:

""

iconName

public abstract 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 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