javax.rad.genui.component
Class AbstractUIActionComponent<C extends IActionComponent>

java.lang.Object
  javax.rad.genui.UIResource<C>
      javax.rad.genui.UIComponent<C>
          javax.rad.genui.component.AbstractUIActionComponent<C>

Type Parameters:

C - instance of IActionComponent

All Implemented Interfaces:

ITranslatable, IActionComponent, IIcon, ILabel, IAlignmentConstants, IComponent, IResource, INamedObject, ITranslator

Direct Known Subclasses:

AbstractUIButton, AbstractUIMenuItem

public abstract class AbstractUIActionComponent<C extends IActionComponent>
extends UIComponent<C>
implements IActionComponent

Platform and technology independent action component. It is designed for use with AWT, Swing, SWT, JSP, JSF, ... .

Field Summary

Fields inherited from class javax.rad.genui.UIComponent

bTranslate, lLastTranslationModified, parent, popupMenu

Fields inherited from class javax.rad.genui.UIResource

uiResource

Fields inherited from interface javax.rad.ui.IAlignmentConstants

ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_DEFAULT, ALIGN_LEFT, ALIGN_RIGHT, ALIGN_STRETCH, ALIGN_TOP

Constructor Summary

protected

AbstractUIActionComponent(C pActionComponent) Creates a new instance of AbstractUIActionComponent.

Method Summary

ActionHandler	eventAction() The EventHandler for the action event.
Key	getAccelerator() Returns the Key which serves as an accelerator for the button.
java.lang.String	getActionCommand() Returns the command name of the action event fired by this action component.
int	getHorizontalAlignment() Returns the alignment along the x axis.
IImage	getImage() Returns the default image.
IInsets	getMargins() Returns the margin between the component's border and the text.
java.lang.String	getText() Returns the text string that the label displays.
int	getVerticalAlignment() Returns the alignment along the y axis.
boolean	isPreserveAspectRatio() If the aspect ratio of the image should be preserved if it is stretched in any direction.
void	setAccelerator(Key pKey) Sets the key combination which invokes the component's action listeners without selecting.
void	setActionCommand(java.lang.String pActionCommand) Sets the command name for the action event fired by this action component.
void	setHorizontalAlignment(int pHorizontalAlignment) Sets the horizontal alignment.
void	setImage(IImage pImage) Sets the default image.
void	setMargins(IInsets pMargins) Sets space for margin between the button's border and the text.
void	setMargins(int pTop, int pLeft, int pBottom, int pRight) Sets the insets with primitive types.
void	setPreserveAspectRatio(boolean pPreserveAspectRatio) Sets if the aspect ratio of the image should be preserved if it is stretched in any direction.
void	setText(java.lang.String pText) Defines the single line of text this component will display.
void	setVerticalAlignment(int pVerticalAlignment) Sets the vertical alignment.
void	updateTranslation() Notification for updating the translation.

Methods inherited from class javax.rad.genui.UIComponent

addNotify, beforeAddNotify, capture, createComponentName, createComponentNamePrefix, debug, doEventKey, doTriggerPopMenu, equals, error, eventComponentMoved, eventComponentResized, eventFocusGained, eventFocusLost, eventKey, eventKeyPressed, eventKeyReleased, eventKeyTyped, eventMouseClicked, eventMouseEntered, eventMouseExited, eventMousePressed, eventMouseReleased, getBackground, getBounds, getComponentUIResource, getCurrentTranslation, getCursor, getDefaultName, getEventSource, getExistingNames, getFactory, getFont, getForeground, getLocation, getLocationOffset, getLocationRelativeTo, getMaximumSize, getMinimumSize, getName, getParent, getPopupMenu, getPreferredSize, getResource, getRootName, getSize, getStyle, getTabIndex, getToolTipText, getTranslation, getUIComponent, hashCode, incrementNameIfExists, info, invokeAndWait, invokeAndWait, invokeInThread, invokeInThread, invokeLater, invokeLater, isBackgroundSet, isBeforeNotified, isCursorSet, isEnabled, isFocusable, isFontSet, isForegroundSet, isMaximumSizeSet, isMinimumSizeSet, isNotified, isPreferredSizeSet, isTranslationChanged, isTranslationEnabled, isVisible, removeNotify, requestFocus, setBackground, setBounds, setBounds, setCursor, setDefaultName, setEnabled, setEventSource, setFocusable, setFont, setForeground, setLocation, setLocation, setLocationRelativeTo, setMaximumSize, setMaximumSize, setMinimumSize, setMinimumSize, setName, setParent, setPopupMenu, setPreferredSize, setPreferredSize, setRootName, setSize, setSize, setStyle, setTabIndex, setToolTipText, setTranslation, setTranslationEnabled, setUIComponent, setVisible, translate

Methods inherited from class javax.rad.genui.UIResource

eventResourceChanged, eventResourceChanged, fireResourceChanged, getObject, getObjectNames, getUIResource, hasResourceHandler, putObject, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.rad.ui.IComponent

capture, eventComponentMoved, eventComponentResized, eventFocusGained, eventFocusLost, eventKeyPressed, eventKeyReleased, eventKeyTyped, eventMouseClicked, eventMouseEntered, eventMouseExited, eventMousePressed, eventMouseReleased, getBackground, getBounds, getCursor, getEventSource, getFactory, getFont, getForeground, getLocation, getLocationRelativeTo, getMaximumSize, getMinimumSize, getName, getParent, getPreferredSize, getSize, getStyle, getTabIndex, getToolTipText, isBackgroundSet, isCursorSet, isEnabled, isFocusable, isFontSet, isForegroundSet, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isVisible, requestFocus, setBackground, setBounds, setCursor, setEnabled, setEventSource, setFocusable, setFont, setForeground, setLocation, setLocationRelativeTo, setMaximumSize, setMinimumSize, setName, setParent, setPreferredSize, setSize, setStyle, setTabIndex, setToolTipText, setVisible

Methods inherited from interface javax.rad.ui.IResource

getResource

Constructor Detail

AbstractUIActionComponent

protected AbstractUIActionComponent(C pActionComponent)

Creates a new instance of AbstractUIActionComponent.

Parameters:

pActionComponent - the IActionComponent.

See Also:

IActionComponent

Method Detail

getText

public java.lang.String getText()

Returns the text string that the label displays.

Specified by:

getText in interface ILabel

Returns:

a String

See Also:

ILabel.setText(java.lang.String)

setText

public void setText(java.lang.String pText)

Defines the single line of text this component will display. If the value of text is null or empty string, nothing is displayed.

Specified by:

setText in interface ILabel

Parameters:

pText - the text

getImage

public IImage getImage()

Returns the default image.

Specified by:

getImage in interface IIcon

Returns:

the default image

See Also:

IIcon.setImage(IImage)

setImage

public void setImage(IImage pImage)

Sets the default image.

Specified by:

setImage in interface IIcon

Parameters:

pImage - the image

See Also:

IIcon.getImage()

getHorizontalAlignment

public int getHorizontalAlignment()

Returns the alignment along the x axis. This specifies how the component would like to be aligned relative to other components. Possible values are defined in AlignmentConstants.

Specified by:

getHorizontalAlignment in interface IAlignmentConstants

Returns:

the horizontal alignment

setHorizontalAlignment

public void setHorizontalAlignment(int pHorizontalAlignment)

Sets the horizontal alignment. Possible values are defined in AlignmentConstants.

Specified by:

setHorizontalAlignment in interface IAlignmentConstants

Parameters:

pHorizontalAlignment - the new vertical alignment

getVerticalAlignment

public int getVerticalAlignment()

Returns the alignment along the y axis. This specifies how the component would like to be aligned relative to other components. Possible values are defined in AlignmentConstants.

Specified by:

getVerticalAlignment in interface IAlignmentConstants

Returns:

the vertical alignment

setVerticalAlignment

public void setVerticalAlignment(int pVerticalAlignment)

Sets the vertical alignment. Possible values are defined in AlignmentConstants.

Specified by:

setVerticalAlignment in interface IAlignmentConstants

Parameters:

pVerticalAlignment - the new vertical alignment

setAccelerator

public void setAccelerator(Key pKey)

Sets the key combination which invokes the component's action listeners without selecting. It is the UI's responsibility to install the correct action.

Specified by:

setAccelerator in interface IActionComponent

Parameters:

pKey - the Key which will serve as an accelerator

getAccelerator

public Key getAccelerator()

Returns the Key which serves as an accelerator for the button.

Specified by:

getAccelerator in interface IActionComponent

Returns:

a Key object identifying the accelerator key

getActionCommand

public java.lang.String getActionCommand()

Returns the command name of the action event fired by this action component.

Specified by:

getActionCommand in interface IActionComponent

Returns:

the action command.

setActionCommand

public void setActionCommand(java.lang.String pActionCommand)

Sets the command name for the action event fired by this action component.

Specified by:

setActionCommand in interface IActionComponent

Parameters:

pActionCommand - a string used to set the action command.

See Also:

ActionEvent

eventAction

public ActionHandler eventAction()

The EventHandler for the action event.

Specified by:

eventAction in interface IActionComponent

Returns:

the EventHandler for the action event.

getMargins

public IInsets getMargins()

Returns the margin between the component's border and the text.

Specified by:

getMargins in interface IActionComponent

Returns:

an IInsets object specifying the margin between the component's border and the text

See Also:

IActionComponent.setMargins(IInsets)

setMargins

public void setMargins(IInsets pMargins)

Sets space for margin between the button's border and the text. Setting to null will cause the action component to use the default margin.

Specified by:

setMargins in interface IActionComponent

Parameters:

pMargins - the space between the border and the test

setMargins

public void setMargins(int pTop,
                       int pLeft,
                       int pBottom,
                       int pRight)

Sets the insets with primitive types.

Parameters:

pTop - the top insets.

pLeft - the left insets.

pBottom - the bottom insets.

pRight - the right insets.

isPreserveAspectRatio

public boolean isPreserveAspectRatio()

If the aspect ratio of the image should be preserved if it is stretched in any direction.

Specified by:

isPreserveAspectRatio in interface IIcon

Returns:

true if the aspect ratio of the image is preserved when stretched.

setPreserveAspectRatio

public void setPreserveAspectRatio(boolean pPreserveAspectRatio)

Sets if the aspect ratio of the image should be preserved if it is stretched in any direction.

Specified by:

setPreserveAspectRatio in interface IIcon

Parameters:

pPreserveAspectRatio - true if the aspect ratio of the image is preserved when stretched.

updateTranslation

public void updateTranslation()

Notification for updating the translation. This method will be called when the UIComponent will be added to a displayable containment hierarchy, when its containment hierarchy is made displayable or the translation table will be changed.

Overrides:

updateTranslation in class UIComponent<C extends IActionComponent>

See Also:

UIComponent.setTranslation(TranslationMap), UIComponent.addNotify()