Skip navigation links

ilog.rules.teamserver.web.model
Interface IlrUICommandModel

All Superinterfaces:

IlrUIModel, Serializable

All Known Implementing Classes:

IlrUICommandModelDelegate

public interface IlrUICommandModel
extends IlrUIModel

Model for a Decision Center command.

Can be represented either by a link or a toolbar button.

Method Summary

String	action() Action to execute when the command is triggered (button or link clicked).
String	getDescription() Gets the description for the command.
String	getDescriptionStyleClass() Gets the CSS class to use when displaying the description of the object.
String	getHref() Gets the destination URL or an anchor point.
String	getIcon() Gets the icon to display for the command.
String	getIconStyleClass() Gets the CSS class to use when displaying the icon of the object using css rule.
String	getKey() Gets the key name of the command.
String	getOnclick() Gets the JavaScript code to execute when the command is clicked on the browser.
String	getStyleClass() Gets the CSS class for the graphical object.
String	getTarget() Gets the window or frame at which to target content
String	getTitle() Gets the title of the graphical object.
String	getTooltip() Gets the tooltip to display for the command.
boolean	isDisabledOnMultiSelection() Tells whether the command is disabled or not on multi selection.
boolean	isDisabledOnNoSelection() Tells whether the command is disabled or not on no selection.
boolean	isDisabledOnOneSelection() Tells whether the command is disabled or not on one selection.
boolean	isDisabledOnTwoSelection() Tells whether the command is disabled or not on two selections.
boolean	isEnabled() Tells whether the associated graphical object must be enabled or not.
boolean	isIconRendered() Tells whether the title is rendered or not.
boolean	isRendered() Tells whether the associated graphical object must be displayed or not.
boolean	isTitleRendered() Tells whether the title is rendered or not.

Method Detail

isRendered

boolean isRendered()

Tells whether the associated graphical object must be displayed or not.

isEnabled

boolean isEnabled()

Tells whether the associated graphical object must be enabled or not.

If the object is a button, it will be grayed out when the isEnabled method returns false.

isTitleRendered

boolean isTitleRendered()

Tells whether the title is rendered or not.

See Also:

getTitle()

isIconRendered

boolean isIconRendered()

Tells whether the title is rendered or not.

See Also:

getIcon()

action

String action()

Action to execute when the command is triggered (button or link clicked).

Returns:

A navigation constant.

getTitle

String getTitle()

Gets the title of the graphical object.

getStyleClass

String getStyleClass()

Gets the CSS class for the graphical object.

getDescription

String getDescription()

Gets the description for the command.

In the Decision Center console, it will be displayed below the links (cf Configure page).

getTooltip

String getTooltip()

Gets the tooltip to display for the command.

getIcon

String getIcon()

Gets the icon to display for the command.

getOnclick

String getOnclick()

Gets the JavaScript code to execute when the command is clicked on the browser.

Returns:

A piece of JavaScript code returning a boolean. Can be null.

getHref

String getHref()

Gets the destination URL or an anchor point.

Returns:

a destination URL or an anchor point.

getTarget

String getTarget()

Gets the window or frame at which to target content

Returns:

The name of the target window or frame or one of _blank, _parent, _top or _self.

getDescriptionStyleClass

String getDescriptionStyleClass()

Gets the CSS class to use when displaying the description of the object.

getIconStyleClass

String getIconStyleClass()

Gets the CSS class to use when displaying the icon of the object using css rule.

getKey

String getKey()

Gets the key name of the command.

isDisabledOnNoSelection

boolean isDisabledOnNoSelection()

Tells whether the command is disabled or not on no selection.

isDisabledOnOneSelection

boolean isDisabledOnOneSelection()

Tells whether the command is disabled or not on one selection.

isDisabledOnTwoSelection

boolean isDisabledOnTwoSelection()

Tells whether the command is disabled or not on two selections.

isDisabledOnMultiSelection

boolean isDisabledOnMultiSelection()

Tells whether the command is disabled or not on multi selection.