com.kheops.ui.component

Class ButtonDef

java.lang.Object

com.kheops.ui.component.ButtonDef

All Implemented Interfaces:

java.lang.Cloneable

public class ButtonDef
extends java.lang.Object
implements java.lang.Cloneable

A ButtonDef is use to define options (icon, text, etc) for a Button.

See Also:

Button

Constructor Summary

Constructors

Constructor and Description
ButtonDef(java.lang.String actionName, javax.swing.ImageIcon icon, java.lang.String buttonText, boolean centerIconText) Constructs a ButtonDef.
ButtonDef(java.lang.String actionName, javax.swing.ImageIcon icon, java.lang.String buttonText, boolean centerIconText, java.awt.Font buttonTextFont) Constructs a ButtonDef.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Clones this ButtonDef
java.lang.String	getActionName() Gets the action name for this button definition.
java.lang.String	getButtonText() Gets the text for this button definition.
java.awt.Font	getFont() Returns the button text font.
javax.swing.Icon	getIcon() Gets the original icon (set by the constructor).
javax.swing.Icon	getIconDisabled() Returns a disabled icon.
boolean	isCenterIconText() Returns true if the text and/or the icon is centered on the button.
boolean	isUpdateToPopupSelection()
void	setFont(java.awt.Font font) Sets the button text font.
void	setIcon(javax.swing.Icon icon) Sets the icon to use.
void	setText(java.lang.String buttonText) Sets the text for this button definition.
void	setUpdateToPopupSelection(boolean updateToPopupSelection) If true (default), set this ButtonDef active if the main button has a ButtonGroup.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ButtonDef

public ButtonDef(java.lang.String actionName,
                 javax.swing.ImageIcon icon,
                 java.lang.String buttonText,
                 boolean centerIconText)

Constructs a ButtonDef.

Parameters:

actionName - the action name that will be fired (required)

icon - an icon to display (optional)

buttonText - the text to display (optional)

centerIconText - is the icon and / or the text will be centered

ButtonDef

public ButtonDef(java.lang.String actionName,
                 javax.swing.ImageIcon icon,
                 java.lang.String buttonText,
                 boolean centerIconText,
                 java.awt.Font buttonTextFont)

Constructs a ButtonDef.

Parameters:

actionName - the action name that will be fired (required)

icon - an icon to display (optional)

buttonText - the text to display (optional)

centerIconText - is the icon and / or the text will be centered

buttonTextFont - the button text font

Method Detail

getActionName

public java.lang.String getActionName()

Gets the action name for this button definition.

Returns:

the action name

getIcon

public javax.swing.Icon getIcon()

Gets the original icon (set by the constructor). Can be null

Returns:

the icon

setIcon

public void setIcon(javax.swing.Icon icon)

Sets the icon to use. null for none

Parameters:

icon - an icon

getButtonText

public java.lang.String getButtonText()

Gets the text for this button definition. Can be null

Returns:

the text

setText

public void setText(java.lang.String buttonText)

Sets the text for this button definition. null for none

Parameters:

buttonText - the new text

isCenterIconText

public boolean isCenterIconText()

Returns true if the text and/or the icon is centered on the button.

Returns:

text / icon center status

getIconDisabled

public javax.swing.Icon getIconDisabled()

Returns a disabled icon. This icon is generated when the original icon is set.

Returns:

a disabled icon

getFont

public java.awt.Font getFont()

Returns the button text font. The default value is UIManager.getFont("Label.font")

Returns:

button text font

setFont

public void setFont(java.awt.Font font)

Sets the button text font. If null is passed, the default UI font will be set.

Parameters:

font -

setUpdateToPopupSelection

public void setUpdateToPopupSelection(boolean updateToPopupSelection)

If true (default), set this ButtonDef active if the main button has a ButtonGroup.

Parameters:

updateToPopupSelection -

isUpdateToPopupSelection

public boolean isUpdateToPopupSelection()

clone

public java.lang.Object clone()

Clones this ButtonDef

Overrides:

clone in class java.lang.Object

Returns:

a clone