de.chandre.admintool.core.component

Class AdminComponentImpl

java.lang.Object

de.chandre.admintool.core.component.AdminComponentImpl

All Implemented Interfaces:

AdminComponent, Comparable<AdminComponent>

public class AdminComponentImpl
extends Object
implements AdminComponent

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

Since:

1.0.0

Author:

Andre

Constructor Summary

Constructors

Constructor and Description
AdminComponentImpl()

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
int	compareTo(AdminComponent o) compares the displayName
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.
void	setSecurityRoles(Set<String> securityRoles)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminComponentImpl

public AdminComponentImpl()

Method Detail

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface AdminComponent

Returns:

the displayName

setDisplayName

public void setDisplayName(String displayName)

Specified by:

setDisplayName in interface AdminComponent

Parameters:

displayName - the displayName to set

getMainMenu

public MenuEntry getMainMenu()

Specified by:

getMainMenu in interface AdminComponent

Returns:

the mainMenu

setMainMenu

public void setMainMenu(MenuEntry mainMenu)

Specified by:

setMainMenu in interface AdminComponent

Parameters:

mainMenu - the mainMenu to set

getNotificationTemplates

public List<String> getNotificationTemplates()

Specified by:

getNotificationTemplates in interface AdminComponent

Returns:

the notificationTemplates

setNotificationTemplates

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

Specified by:

setNotificationTemplates in interface AdminComponent

Parameters:

notificationTemplates - the notificationTemplates to set

See Also:

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

addNotificationTemplate

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

Specified by:

addNotificationTemplate in interface AdminComponent

Parameters:

notificationTemplate - the template path to notification template

See Also:

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

getAdditionalCSS

public Map<String,Boolean> getAdditionalCSS()

Specified by:

getAdditionalCSS in interface AdminComponent

Returns:

the additionalCSS

setAdditionalCSS

public void setAdditionalCSS(Map<String,Boolean> additionalCSS)

map with paths to CSS.

Specified by:

setAdditionalCSS in interface AdminComponent

Parameters:

additionalCSS - the additionalCSS to set

See Also:

addAdditionalCSS(String, boolean)

addAdditionalCSS

public void addAdditionalCSS(String additionalCSS,
                             boolean relative)

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

Specified by:

addAdditionalCSS in interface AdminComponent

Parameters:

additionalCSS - the additionalCSS to set

getAdditionalJS

public Map<String,Boolean> getAdditionalJS()

Specified by:

getAdditionalJS in interface AdminComponent

Returns:

the additionalJS

setAdditionalJS

public void setAdditionalJS(Map<String,Boolean> additionalJS)

map with path to additional JavaScript files.

Specified by:

setAdditionalJS in interface AdminComponent

Parameters:

additionalJS - the additionalJS to set

See Also:

addAdditionalJS(String, boolean)

addAdditionalJS

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

Specified by:

addAdditionalJS in interface AdminComponent

Parameters:

additionalJS - the additionalJS to set

getSecurityRoles

public Set<String> getSecurityRoles()

Description copied from interface: AdminComponent

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

Specified by:

getSecurityRoles in interface AdminComponent

Returns:

the securityRoles

Since:

1.0.1

See Also:

addSecurityRole(String)

setSecurityRoles

public void setSecurityRoles(Set<String> securityRoles)

Parameters:

securityRoles - the securityRoles to set

Since:

1.0.1

See Also:

addSecurityRole(String)

addSecurityRole

public void addSecurityRole(String securityRole)

Description copied from interface: AdminComponent

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

Specified by:

addSecurityRole in interface AdminComponent

getPosition

public Integer getPosition()

Description copied from interface: AdminComponent

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

Specified by:

getPosition in interface AdminComponent

Returns:

the position

Since:

1.0.1

setPosition

public void setPosition(Integer position)

Description copied from interface: AdminComponent

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

Specified by:

setPosition in interface AdminComponent

Parameters:

position - the position to set

Since:

1.0.1

compareTo

public int compareTo(AdminComponent o)

compares the displayName

Specified by:

compareTo in interface Comparable<AdminComponent>

toString

public String toString()

Overrides:

toString in class Object