com.xdev.ui.action

Interface ActionComponent

All Known Implementing Classes:

XdevButton, XdevMenuBar.XdevMenuItem, XdevNativeButton

public interface ActionComponent

An ActionComponent is a Component which can be connected to an Action.

Author:

XDEV Software

See Also:

Action, Component

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ActionComponent.ActionPropertyChangeListener
static class	ActionComponent.Utils

Method Summary

Modifier and Type	Method and Description
Action	getAction() Returns the action which this component is connected to.
void	setAction(Action action) Connects this component with an action.
void	setCaption(String caption) Sets the caption of the component.
void	setDescription(String description) Sets the component's description.
void	setEnabled(boolean enabled) Enables or disables the component.
void	setIcon(Resource icon) Sets the icon of the component.

Method Detail

getAction

Action getAction()

Returns the action which this component is connected to.

Returns:

this component's action

setAction

void setAction(Action action)

Connects this component with an action. Properties like text, icon and the enabled state will be used from the action.

The main action of this component, like click of a button, will trigger the actions ActionListener.actionPerformed(com.xdev.ui.event.ActionEvent) method.

Parameters:

action - the connected action

setCaption

void setCaption(String caption)

Sets the caption of the component.

Parameters:

caption - the new caption for the component. If the caption is null, no caption is shown and it does not normally take any space

See Also:

Component.setCaption(String)

setIcon

void setIcon(Resource icon)

Sets the icon of the component.

Parameters:

icon - the icon of the component. If null, no icon is shown and it does not normally take any space

See Also:

Component.setIcon(Resource)

setDescription

void setDescription(String description)

Sets the component's description.

Parameters:

description - the new description string for the component

See Also:

AbstractComponent.setDescription(String)

setEnabled

void setEnabled(boolean enabled)

Enables or disables the component. The user can not interact disabled components, which are shown with a style that indicates the status, usually shaded in light gray color. Components are enabled by default.

Parameters:

enabled - a boolean value specifying if the component should be enabled or not

See Also:

Component.setEnabled(boolean)