de.chandre.admintool.core.component

Interface AdminComponent

All Superinterfaces:

Comparable<AdminComponent>

All Known Implementing Classes:

AdminComponentImpl

public interface AdminComponent
extends Comparable<AdminComponent>

A admin component
should have at least a minimum of one menu entry

Author:

Andre

Method Summary

Modifier and Type	Method and Description
void	addAdditionalCSS(String additionalCSS, boolean relative) path to CSS.
void	addAdditionalJS(String additionalJS, boolean relative) path to additional JavaScript files.
void	addNotificationTemplate(String notificationTemplate) path to notification template shown in the top right menu should start with a "li" tag. eg: <li class="dropdown messages-menu">
void	addSecurityRole(String securityRole) security role like "ROLE_USER" or for anonymous "ROLE_ANONYMOUS" validated with spring security requires: admin-tool-core-security setting these roles will no effect on access, only for displaying or hiding menu entries the access restrictions must be done by your own with the security configuration
Map<String,Boolean>	getAdditionalCSS()
Map<String,Boolean>	getAdditionalJS()
String	getDisplayName()
MenuEntry	getMainMenu()
List<String>	getNotificationTemplates()
Integer	getPosition() position of component in menu.
Set<String>	getSecurityRoles() should return a list of roles which should be able to access this component
void	setAdditionalCSS(Map<String,Boolean> additionalCSS) map with paths to CSS.
void	setAdditionalJS(Map<String,Boolean> additionalJS) map with path to additional JavaScript files.
void	setDisplayName(String displayName)
void	setMainMenu(MenuEntry mainMenu)
void	setNotificationTemplates(List<String> notificationTemplates) path to notification template shown in the top right menu should start with a "li" tag. eg: <li class="dropdown messages-menu">
void	setPosition(Integer position) position of component in menu.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getDisplayName

String getDisplayName()

Returns:

the displayName

setDisplayName

void setDisplayName(String displayName)

Parameters:

displayName - the displayName to set

getMainMenu

MenuEntry getMainMenu()

Returns:

the mainMenu

setMainMenu

void setMainMenu(MenuEntry mainMenu)

Parameters:

mainMenu - the mainMenu to set

getNotificationTemplates

List<String> getNotificationTemplates()

Returns:

the notificationTemplates

setNotificationTemplates

void setNotificationTemplates(List<String> notificationTemplates)

path to notification template shown in the top right menu
should start with a "li" tag. eg:
<li class="dropdown messages-menu">

Parameters:

notificationTemplates - the notificationTemplates to set

See Also:

https://almsaeedstudio.com/themes/AdminLTE/documentation/index.html#component-main-header

addNotificationTemplate

void addNotificationTemplate(String notificationTemplate)

path to notification template shown in the top right menu
should start with a "li" tag. eg:
<li class="dropdown messages-menu">

Parameters:

notificationTemplate - the template path to notification template

See Also:

https://almsaeedstudio.com/themes/AdminLTE/documentation/index.html#component-main-header

getAdditionalCSS

Map<String,Boolean> getAdditionalCSS()

Returns:

the additionalCSS

setAdditionalCSS

void setAdditionalCSS(Map<String,Boolean> additionalCSS)

map with paths to CSS.

Parameters:

additionalCSS - the additionalCSS to set

See Also:

addAdditionalCSS(String, boolean)

addAdditionalCSS

void addAdditionalCSS(String additionalCSS,
                      boolean relative)

path to CSS.
Example:
addAdditionalCSS("/static/myComponent/css/myStyles.css", true);
addAdditionalCSS("http://example.com/styles.css", false);

Parameters:

additionalCSS - the additionalCSS to set

getAdditionalJS

Map<String,Boolean> getAdditionalJS()

Returns:

the additionalJS

setAdditionalJS

void setAdditionalJS(Map<String,Boolean> additionalJS)

map with path to additional JavaScript files.

Parameters:

additionalJS - the additionalJS to set

See Also:

addAdditionalJS(String, boolean)

addAdditionalJS

void addAdditionalJS(String additionalJS,
                     boolean relative)

path to additional JavaScript files.
Example:
addAdditionalJS("/static/myComponent/js/myScripts.js", true);
addAdditionalJS("http://example.com/script.js", false);

Parameters:

additionalJS - the additionalJS to set

getSecurityRoles

Set<String> getSecurityRoles()

should return a list of roles which should be able to access this component

Returns:

Since:

1.0.1

addSecurityRole

void addSecurityRole(String securityRole)

security role like "ROLE_USER" or for anonymous "ROLE_ANONYMOUS" validated with spring security
requires: admin-tool-core-security
setting these roles will no effect on access, only for displaying or hiding menu entries
the access restrictions must be done by your own with the security configuration

Parameters:

securityRole -

Since:

1.0.1

getPosition

Integer getPosition()

position of component in menu. Initially set to Integer.MAX_VALUE

Returns:

Since:

1.0.1

setPosition

void setPosition(Integer position)

position of component in menu. Initially set to Integer.MAX_VALUE

Parameters:

position -

Since:

1.0.1