com.ribs.helpers

Class AbstractButtonHpr

java.lang.Object

com.ribs.RJHelper

com.ribs.helpers.JButtonOrLabelHpr

com.ribs.helpers.AbstractButtonHpr

Direct Known Subclasses:

RJCheckBoxHpr

public class AbstractButtonHpr
extends JButtonOrLabelHpr

This class is a simple JButton subclass to support Ribs archival and to support Ribs unified accessor model.

Copyright (c) 2004 ReportMill Software, Inc. All Rights Reserved. Contact ReportMill .

Constructor Summary

Constructors

Constructor and Description
AbstractButtonHpr()

Method Summary

Modifier and Type	Method and Description
void	fromXML(javax.swing.JComponent aComponent, RXArchiver anArchiver, RXElement anElement) XML unarchival.
boolean	getBoolValue(javax.swing.JComponent aComponent) Returns the button's bool value.
javax.swing.ButtonGroup	getButtonGroup(javax.swing.JComponent aComponent) Returns the actual button group instance for this button
java.lang.String	getButtonGroupName(javax.swing.JComponent aComponent) Returns the button group name for this button.
java.lang.String	getMarginString(javax.swing.AbstractButton aButton) Returns the margin string for a button, if it's been explicity set in Ribs.
java.lang.String	getSelectedImageName(javax.swing.JComponent aComponent) Returns the image name for this button's icon when selected.
boolean	getSendActionOnClick(javax.swing.AbstractButton aButton) Returns whether this button sends action when clicked.
boolean	getSendActionOnDoubleClick(javax.swing.AbstractButton aButton) Returns whether this button sends action when double-clicked.
java.lang.String	getStringValue(javax.swing.JComponent aComponent) Returns the button's visible text.
java.lang.Object	getValue(javax.swing.JComponent aComponent) Returns the button's value.
void	initInstance(javax.swing.JComponent aComponent) Initializes the given instance (actually called the first time an owner is set).
java.lang.Object	newInstance(RXElement anElement) Creates a new instance of class for given element.
void	setButtonGroupName(javax.swing.JComponent aComponent, java.lang.String aName) This method sets the button group name for this button and tries to set the button group by asking its parent RJPanel for the button group with the given name (the parent RJPanel will create one if necessary).
void	setMarginString(javax.swing.AbstractButton aButton, java.lang.String aString) Sets the margin string for a button.
void	setSelectedImageName(javax.swing.JComponent aComponent, java.lang.String aName) Sets the image name for this button's icon when selected.
void	setSendActionOnClick(javax.swing.AbstractButton aButton, boolean aValue) Sets whether this button sends action when clicked.
void	setSendActionOnDoubleClick(javax.swing.AbstractButton aButton, boolean aValue) Sets whether this button sends action when double-clicked.
void	setValue(javax.swing.JComponent aComponent, boolean aValue) Sets the button's boolean value.
void	setValue(javax.swing.JComponent aComponent, java.lang.String aValue) Sets the visible button text.
RXElement	toXML(javax.swing.JComponent aComponent, RXArchiver anArchiver) XML archival.

Methods inherited from class com.ribs.helpers.JButtonOrLabelHpr

getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getImageName, getText, getVerticalAlignment, getVerticalTextPosition, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setImageName, setText, setVerticalAlignment, setVerticalTextPosition

Methods inherited from class com.ribs.RJHelper

add, focusGained, focusLost, fromXMLDeep, get, getActionListener, getAutoscrolls, getAutosizing, getBackground, getBindKey, getBooleanValue, getCallback, getChangeListener, getColorValue, getComponent, getComponentCount, getFloatValue, getFocusListener, getForeground, getIntValue, getMaster, getMaximumSize, getMinimumSize, getOwner, getRibHeight, getRibWidth, getRibX, getRibY, getSendActionOnFocusLost, getSubstitutionClassString, isOpaque, performBindKeyGet, performBindKeySet, sendAction, setAutoscrolls, setAutosizing, setBackground, setBindKey, setCallback, setForeground, setMaster, setMaximumSize, setMinimumSize, setOpaque, setOwner, setSendActionOnFocusLost, setSubstitutionClassString, setValue, setValue, setValue, setValue, setValue, takeFloatValue, takeIntValue, testOutBeanBag, toXMLDeep

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractButtonHpr

public AbstractButtonHpr()

Method Detail

newInstance

public java.lang.Object newInstance(RXElement anElement)

Creates a new instance of class for given element.

Overrides:

newInstance in class RJHelper

initInstance

public void initInstance(javax.swing.JComponent aComponent)

Initializes the given instance (actually called the first time an owner is set).

Overrides:

initInstance in class RJHelper

getSelectedImageName

public java.lang.String getSelectedImageName(javax.swing.JComponent aComponent)

Returns the image name for this button's icon when selected.

setSelectedImageName

public void setSelectedImageName(javax.swing.JComponent aComponent,
                                 java.lang.String aName)

Sets the image name for this button's icon when selected.

getButtonGroupName

public java.lang.String getButtonGroupName(javax.swing.JComponent aComponent)

Returns the button group name for this button.

getButtonGroup

public javax.swing.ButtonGroup getButtonGroup(javax.swing.JComponent aComponent)

Returns the actual button group instance for this button

setButtonGroupName

public void setButtonGroupName(javax.swing.JComponent aComponent,
                               java.lang.String aName)

This method sets the button group name for this button and tries to set the button group by asking its parent RJPanel for the button group with the given name (the parent RJPanel will create one if necessary).

getSendActionOnClick

public boolean getSendActionOnClick(javax.swing.AbstractButton aButton)

Returns whether this button sends action when clicked.

setSendActionOnClick

public void setSendActionOnClick(javax.swing.AbstractButton aButton,
                                 boolean aValue)

Sets whether this button sends action when clicked.

getSendActionOnDoubleClick

public boolean getSendActionOnDoubleClick(javax.swing.AbstractButton aButton)

Returns whether this button sends action when double-clicked.

setSendActionOnDoubleClick

public void setSendActionOnDoubleClick(javax.swing.AbstractButton aButton,
                                       boolean aValue)

Sets whether this button sends action when double-clicked.

getMarginString

public java.lang.String getMarginString(javax.swing.AbstractButton aButton)

Returns the margin string for a button, if it's been explicity set in Ribs.

setMarginString

public void setMarginString(javax.swing.AbstractButton aButton,
                            java.lang.String aString)

Sets the margin string for a button.

getValue

public java.lang.Object getValue(javax.swing.JComponent aComponent)

Returns the button's value.

Overrides:

getValue in class RJHelper

getStringValue

public java.lang.String getStringValue(javax.swing.JComponent aComponent)

Returns the button's visible text.

Overrides:

getStringValue in class RJHelper

setValue

public void setValue(javax.swing.JComponent aComponent,
                     java.lang.String aValue)

Sets the visible button text.

Overrides:

setValue in class RJHelper

getBoolValue

public boolean getBoolValue(javax.swing.JComponent aComponent)

Returns the button's bool value.

Overrides:

getBoolValue in class RJHelper

setValue

public void setValue(javax.swing.JComponent aComponent,
                     boolean aValue)

Sets the button's boolean value.

Overrides:

setValue in class RJHelper

toXML

public RXElement toXML(javax.swing.JComponent aComponent,
                       RXArchiver anArchiver)

XML archival.

Overrides:

toXML in class JButtonOrLabelHpr

fromXML

public void fromXML(javax.swing.JComponent aComponent,
                    RXArchiver anArchiver,
                    RXElement anElement)

XML unarchival.

Overrides:

fromXML in class JButtonOrLabelHpr