de.chandre.admintool.core

Interface AdminTool

All Known Implementing Classes:

AdminToolImpl

public interface AdminTool

AdminTool core interface to get and add components.
a component represents a main menu entry with possible sub menu entries
it's also possible to add custom java scripts and css

Author:

Andre

Field Summary

Fields

Modifier and Type	Field and Description
static String	GENERIC_ERROR_TPL_PATH path to default error template: admintool/content/error
static String	ROOTCONTEXT root context path with a leading slash
static String	ROOTCONTEXT_NAME name of admintool.
static String	SLASH just a slash

Method Summary

Modifier and Type	Method and Description
void	addComponent(AdminComponent components)
void	addComponents(Set<AdminComponent> components)
void	addGlobalJavaScript(String globalJavaScript, boolean relative) Example: addGlobalJavaScript("/static/myComponent/js/myScript.js", true); addGlobalJavaScript("http://example.com/script.js", false);
void	addGlobalStyleSheet(String globalStyleSheet, boolean relative) Example: addGlobalStyleSheet("/static/myComponent/css/myStyles.css", true); addGlobalStyleSheet("http://example.com/styles.css", false);
Set<AdminComponent>	getComponents()
Map<String,Boolean>	getGlobalJavaScripts() A map with script url as key and a boolean if it's a relative url Example: getGlobalJavaScripts().put("/static/myComponent/js/myScript.js", true); getGlobalJavaScripts().put("http://example.com/script.js", false);
Map<String,Boolean>	getGlobalStyleSheets() A map with css url as key and a boolean if it's a relative url Example: getGlobalStyleSheets().put("/static/myComponent/css/myStyles.css", true); getGlobalStyleSheets().put("http://example.com/styles.css", false);
MenuEntrySearchResult	searchComponent(String menuName) searches for a menuEntry with specified name
void	setComponentComparator(Comparator<AdminComponent> comparator) to set a custom comparator for ordering components.

Field Detail

SLASH

static final String SLASH

just a slash

See Also:

Constant Field Values

ROOTCONTEXT_NAME

static final String ROOTCONTEXT_NAME

name of admintool.

See Also:

Constant Field Values

ROOTCONTEXT

static final String ROOTCONTEXT

root context path with a leading slash

See Also:

Constant Field Values

GENERIC_ERROR_TPL_PATH

static final String GENERIC_ERROR_TPL_PATH

path to default error template: admintool/content/error

See Also:

Constant Field Values

Method Detail

setComponentComparator

void setComponentComparator(Comparator<AdminComponent> comparator)

to set a custom comparator for ordering components.

Parameters:

comparator - own comparator or null. if null the default compare implementation of AdminComponent will be used

Since:

1.0.1

getComponents

Set<AdminComponent> getComponents()

Returns:

addComponent

void addComponent(AdminComponent components)

Parameters:

components -

addComponents

void addComponents(Set<AdminComponent> components)

Parameters:

components -

getGlobalJavaScripts

Map<String,Boolean> getGlobalJavaScripts()

A map with script url as key and a boolean if it's a relative url
Example:
getGlobalJavaScripts().put("/static/myComponent/js/myScript.js", true);
getGlobalJavaScripts().put("http://example.com/script.js", false);

Returns:

addGlobalJavaScript

void addGlobalJavaScript(String globalJavaScript,
                         boolean relative)

Example:
addGlobalJavaScript("/static/myComponent/js/myScript.js", true);
addGlobalJavaScript("http://example.com/script.js", false);

Parameters:

globalJavaScript -

relative - if url is relative (not absolute) and pointing to the server

getGlobalStyleSheets

Map<String,Boolean> getGlobalStyleSheets()

A map with css url as key and a boolean if it's a relative url Example:
getGlobalStyleSheets().put("/static/myComponent/css/myStyles.css", true);
getGlobalStyleSheets().put("http://example.com/styles.css", false);

Returns:

addGlobalStyleSheet

void addGlobalStyleSheet(String globalStyleSheet,
                         boolean relative)

Example:
addGlobalStyleSheet("/static/myComponent/css/myStyles.css", true);
addGlobalStyleSheet("http://example.com/styles.css", false);

Parameters:

globalStyleSheet -

relative - if url is relative (not absolute) and pointing to the server

searchComponent

MenuEntrySearchResult searchComponent(String menuName)

searches for a menuEntry with specified name

Parameters:

menuName -

Returns:

null or MenuEntrySearchResult

Since:

1.0.1