de.chandre.admintool.core

Class AdminToolImpl

java.lang.Object

de.chandre.admintool.core.AdminToolImpl

All Implemented Interfaces:

AdminTool

@Component(value="adminTool")
public class AdminToolImpl
extends Object
implements AdminTool

the admin tool
create a new AdminComponent and use AdminTool.addComponent(AdminComponent) to get it displayed

Author:

Andre

Field Summary

Fields inherited from interface de.chandre.admintool.core.AdminTool

GENERIC_ERROR_TPL_PATH, ROOTCONTEXT, ROOTCONTEXT_NAME, SLASH

Constructor Summary

Constructors

Constructor and Description
AdminToolImpl()

Method Summary

Modifier and Type	Method and Description
void	addComponent(AdminComponent components)
void	addComponents(Set<AdminComponent> components)
void	addGlobalJavaScript(String globalJavaScript, boolean local) Example: addGlobalJavaScript("/static/myComponent/js/myScript.js", true); addGlobalJavaScript("http://example.com/script.js", false);
void	addGlobalStyleSheet(String globalStyleSheet, boolean local) 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.
void	setComponents(Set<AdminComponent> components)
void	setGlobalJavaScripts(Map<String,Boolean> globalJavaScripts)
void	setGlobalStyleSheet(Map<String,Boolean> globalStyleSheets)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AdminToolImpl

public AdminToolImpl()

Method Detail

setComponentComparator

public void setComponentComparator(Comparator<AdminComponent> comparator)

Description copied from interface: AdminTool

to set a custom comparator for ordering components.

Specified by:

setComponentComparator in interface AdminTool

Parameters:

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

getComponents

public Set<AdminComponent> getComponents()

Specified by:

getComponents in interface AdminTool

Returns:

the components

addComponent

public void addComponent(AdminComponent components)

Specified by:

addComponent in interface AdminTool

Parameters:

components - the components to set

addComponents

public void addComponents(Set<AdminComponent> components)

Specified by:

addComponents in interface AdminTool

Parameters:

components - the components to set

setComponents

public void setComponents(Set<AdminComponent> components)

getGlobalJavaScripts

public Map<String,Boolean> getGlobalJavaScripts()

Description copied from interface: AdminTool

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);

Specified by:

getGlobalJavaScripts in interface AdminTool

Returns:

setGlobalJavaScripts

public void setGlobalJavaScripts(Map<String,Boolean> globalJavaScripts)

addGlobalJavaScript

public void addGlobalJavaScript(String globalJavaScript,
                                boolean local)

Description copied from interface: AdminTool

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

Specified by:

addGlobalJavaScript in interface AdminTool

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

getGlobalStyleSheets

public Map<String,Boolean> getGlobalStyleSheets()

Description copied from interface: AdminTool

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);

Specified by:

getGlobalStyleSheets in interface AdminTool

Returns:

setGlobalStyleSheet

public void setGlobalStyleSheet(Map<String,Boolean> globalStyleSheets)

addGlobalStyleSheet

public void addGlobalStyleSheet(String globalStyleSheet,
                                boolean local)

Description copied from interface: AdminTool

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

Specified by:

addGlobalStyleSheet in interface AdminTool

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

searchComponent

public MenuEntrySearchResult searchComponent(String menuName)

Description copied from interface: AdminTool

searches for a menuEntry with specified name

Specified by:

searchComponent in interface AdminTool

Returns:

null or MenuEntrySearchResult

toString

public String toString()

Overrides:

toString in class Object