org.jahia.services.uicomponents.bean.toolbar

Class Item

java.lang.Object

org.jahia.services.uicomponents.bean.toolbar.Item

All Implemented Interfaces:

Serializable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

Menu

public class Item
extends Object
implements Serializable, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean, org.springframework.context.ApplicationContextAware

User: jahia Date: 7 avr. 2008 Time: 09:05:20

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Item.PermissionsStrategy Provides a way to specify how to interpret a list of required permissions.

Constructor Summary

Constructors

Constructor and Description
Item()

Method Summary

Modifier and Type	Method and Description
void	addProperty(Property property)
void	afterPropertiesSet()
void	destroy()
boolean	equals(Object obj)
org.jahia.ajax.gwt.client.widget.toolbar.action.ActionItem	getActionItem()
String	getDescriptionKey()
String	getIcon()
String	getId()
String	getLayout()
List<Property>	getProperties()
String	getRequiredModule()
String	getRequiredPermission() Deprecated. Please consider using getRequiredPermissions() instead of this method. If multiple permissions were provided (using setRequiredPermissions(List) then this method will only return the first one.
List<String>	getRequiredPermissions() Returns the list of required permissions to enable this item.
Item.PermissionsStrategy	getRequiredPermissionsStrategy() Returns the permission strategy to use to interpret required permissions.
Selected	getSelected()
String	getTitle()
String	getTitleKey()
Visibility	getVisibility()
int	hashCode()
boolean	isDisplayTitle()
boolean	isHideWhenDisabled()
void	setActionItem(org.jahia.ajax.gwt.client.widget.toolbar.action.ActionItem actionItem)
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setBeanName(String name)
void	setDescriptionKey(String descriptionKey)
void	setDisplayTitle(boolean displayTitle)
void	setHideWhenDisabled(boolean hideWhenDisabled)
void	setIcon(String icon)
void	setId(String id)
void	setLayout(String layout)
void	setParent(Object parent)
void	setParentMenu(Menu menu)
void	setParentToolbar(Toolbar toolbar)
void	setPosition(int position)
void	setPositionAfter(String positionAfter)
void	setPositionBefore(String positionBefore)
void	setProperties(List<Property> properties)
void	setRequiredModule(String requiredModule)
void	setRequiredPermission(String requiredPermission)
void	setRequiredPermissions(List<String> requiredPermissions) Sets a list of required permissions to enable this item.
void	setRequiredPermissionsStrategy(Item.PermissionsStrategy permissionsStrategy) Sets the permission strategy to use to interpret required permissions.
void	setSelected(Selected selected)
void	setTitle(String title)
void	setTitleKey(String titleKey)
void	setVisibility(Visibility visibility)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Item

public Item()

Method Detail

getId

public String getId()

setId

public void setId(String id)

getIcon

public String getIcon()

setIcon

public void setIcon(String icon)

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

getTitleKey

public String getTitleKey()

setTitleKey

public void setTitleKey(String titleKey)

isDisplayTitle

public boolean isDisplayTitle()

setDisplayTitle

public void setDisplayTitle(boolean displayTitle)

getDescriptionKey

public String getDescriptionKey()

setDescriptionKey

public void setDescriptionKey(String descriptionKey)

getVisibility

public Visibility getVisibility()

setVisibility

public void setVisibility(Visibility visibility)

getSelected

public Selected getSelected()

setSelected

public void setSelected(Selected selected)

setProperties

public void setProperties(List<Property> properties)

getProperties

public List<Property> getProperties()

addProperty

public void addProperty(Property property)

setBeanName

public void setBeanName(String name)

Specified by:

setBeanName in interface org.springframework.beans.factory.BeanNameAware

getActionItem

public org.jahia.ajax.gwt.client.widget.toolbar.action.ActionItem getActionItem()

setActionItem

public void setActionItem(org.jahia.ajax.gwt.client.widget.toolbar.action.ActionItem actionItem)

getLayout

public String getLayout()

setLayout

public void setLayout(String layout)

getRequiredPermission

@Deprecated
public String getRequiredPermission()

Deprecated. Please consider using getRequiredPermissions() instead of this method. If multiple permissions were provided (using setRequiredPermissions(List) then this method will only return the first one.

Returns the required permission for enabling this item.

Returns:

the required permission if any, null otherwise

getRequiredPermissions

public final List<String> getRequiredPermissions()

Returns the list of required permissions to enable this item.

getRequiredPermissionsStrategy() indicates how the required permissions should be interpreted.

Returns:

a list of required permissions

getRequiredPermissionsStrategy

public final Item.PermissionsStrategy getRequiredPermissionsStrategy()

Returns the permission strategy to use to interpret required permissions.

Returns:

the permission strategy to use

getRequiredModule

public String getRequiredModule()

setRequiredModule

public void setRequiredModule(String requiredModule)

setRequiredPermission

public void setRequiredPermission(String requiredPermission)

setRequiredPermissions

public final void setRequiredPermissions(List<String> requiredPermissions)

Sets a list of required permissions to enable this item.

setRequiredPermissionsStrategy(PermissionsStrategy) allows to specify how this list of permissions should be interpreted.

Parameters:

requiredPermissions - a list of permissions

setRequiredPermissionsStrategy

public final void setRequiredPermissionsStrategy(Item.PermissionsStrategy permissionsStrategy)

Sets the permission strategy to use to interpret required permissions.

Parameters:

permissionsStrategy - the permission strategy to use

isHideWhenDisabled

public boolean isHideWhenDisabled()

setHideWhenDisabled

public void setHideWhenDisabled(boolean hideWhenDisabled)

setParent

public void setParent(Object parent)

setParentMenu

public void setParentMenu(Menu menu)

setParentToolbar

public void setParentToolbar(Toolbar toolbar)

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

destroy

public void destroy()
             throws Exception

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

Throws:

Exception

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

setPosition

public void setPosition(int position)

setPositionAfter

public void setPositionAfter(String positionAfter)

setPositionBefore

public void setPositionBefore(String positionBefore)