org.nuclos.api.ui

Interface ResultToolbarItemFactory

public interface ResultToolbarItemFactory

Method Summary

Modifier and Type	Method and Description
UID	getEntityUid() Returns the UID of the business object for the result list the button is shown in.
javax.swing.Icon	getIcon() Returns the button's icon which is placed left of the label.
java.lang.Object	getId() Returns the id
java.lang.String	getLabel() Returns the button's label.
int	getOrder() Returns an integer which is used to determine the order of the buttons in the result list toolbar.
java.lang.String	getTooltip() Returns the button's tooltip.
boolean	isAllowed(java.util.Set<UID> grantedActions) Returns true if the user is allowed to use this button based on actions in T_AD_ACTION granted to him/her.
ResultToolbarItem	newInstance() Resturns new button.

Method Detail

getId

java.lang.Object getId()

Returns the id

Returns:

the id

getEntityUid

UID getEntityUid()

Returns the UID of the business object for the result list the button is shown in. If the return value is null the button is shown in every result list of all business objects

Returns:

the UID of the business object

getLabel

java.lang.String getLabel()

Returns the button's label.

Returns:

the button's label

getTooltip

java.lang.String getTooltip()

Returns the button's tooltip.

Returns:

the button's tooltip

getIcon

javax.swing.Icon getIcon()

Returns the button's icon which is placed left of the label.

Returns:

the button's icon

getOrder

int getOrder()

Returns an integer which is used to determine the order of the buttons in the result list toolbar. If two button share the same order number the order depends on which class is found first by the class loader which is unpredictable.

Returns:

order number

isAllowed

boolean isAllowed(java.util.Set<UID> grantedActions)

Returns true if the user is allowed to use this button based on actions in T_AD_ACTION granted to him/her.

Parameters:

grantedActions - set of UIDs from actions defined in T_AD_ACTION granted to the current user via "administration/user roles"

Returns:

true if user is allowed to use this button

newInstance

ResultToolbarItem newInstance()

Resturns new button.

Returns:

new button