IBM Branch Transformation Toolkit Javadoc

com.ibm.dse.gui
Class SpButtonGroup

java.lang.Object
  extended byjavax.swing.ButtonGroup
      extended bycom.ibm.dse.gui.SpButtonGroup
All Implemented Interfaces:
DataExchanger, Outsider, PanelActions, java.io.Serializable

public class SpButtonGroup
extends javax.swing.ButtonGroup
implements Outsider

The SpButtonGroup class is a Bean that provides a set of mutually exclusive choices that appear as radio buttons

See Also:
Serialized Form

Field Summary
 
Fields inherited from class javax.swing.ButtonGroup
buttons
 
Constructor Summary
SpButtonGroup()
          This constructor creates a SpButtonGroup object.
 
Method Summary
 void add(javax.swing.AbstractButton b)
          Adds the button to the group.
 void addActionListener(java.awt.event.ActionListener l)
          Documented in the JDK.
 void addCoordinatedEventListener(CoordinatedEventListener newListener)
          Adds an CoordinatedEventListener.
 void addDataChangedListener(DataChangedListener newListener)
          Deprecated. (use addCoordinatedEventListener(CoordinatedEventListener newListener))
 void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
          Generated to support the propertyChange field.
 void executeBeanReactions(java.awt.Component spRad)
          When a Bean changes states and the end state is a non-error state, the Bean will call the beanReaction(java.awt.Component) public static method of the specified class.
 void fireCoordinationEvent()
          Fires a DSECoordinationEvent when data has changed.
 void fireCoordinationEvent(DSECoordinationEvent event)
          Fires a DSECoordinationEvent when data has changed.
 void fireDataChanged()
          Deprecated. (use fireCoordinationEvent())
 void fireHandleDataChanged(DataChangedEvent event)
          Method to support listener events.
 void firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
          Generated to support the propertyChange field.
 java.lang.String getAlternativeDataName()
          Gets the alternativeDataName property (java.lang.String) value.
 java.lang.String getBeansReactions()
          Gets the beansReactions property (java.lang.String) value.
 java.lang.String getDataDirection()
          Gets the dataDirection property (java.lang.String) value.
 java.lang.String getDataName()
          Gets the dataName property (java.lang.String) value.
 java.lang.String getDataToClear()
          Gets the dataToClear property (java.lang.String) value.
 java.lang.Object getDataValue()
          Gets the dataValue property (java.lang.Object) value.
 DSECoordinatedPanel getDSECoordinatedPanel()
          Gets the DSECoordinatedPanel where the component is placed
 java.lang.String getErrorMessage()
          Gets the ErrorMessage property value from its formatters (if exists).
 NavigationParameters getNavigationParameters()
          Gets the navigationParameters property (com.ibm.dse.gui.NavigationParameters) value.
protected  java.beans.PropertyChangeSupport getPropertyChange()
          Accessor for the propertyChange field.
 boolean getRequired()
          Gets the required property (boolean) value.
 SpPanel getSpPanel()
          Gets the spPanel property (com.ibm.dse.gui.SpPanel) value.
 java.lang.String getType()
          Gets the type property (java.lang.String) value.
 boolean hasAlternativeDataName()
          Returns if the SpButtonGroup has alternative data name attribute.
 boolean isInError()
          Complies with the DataExchanger interface.
 boolean isKeyedValue()
          if true this bean returns a composed data value.
 boolean isRequired()
          Returns if the ButtonGroup is required or not.
 void removeActionListener(java.awt.event.ActionListener l)
          To comply with DataExchanger interface.
 void removeCoordinatedEventListener(CoordinatedEventListener newListener)
          Removes a CoordinatedEventListener.
 void removeDataChangedListener(DataChangedListener newListener)
          Deprecated. (use removeCoordinatedEventListener(CoordinatedEventListener newListener))
 void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
          Generated to support the propertyChange field.
 void setAlternativeDataName(java.lang.String alternativeDataName)
          Sets the alternativeDataName property (java.lang.String) value.
 void setBeansReactions(java.lang.String beansReactions)
          Sets the beansReactions property (java.lang.String) value.
 void setDataDirection(java.lang.String dataDirection)
          Sets the dataDirection property (java.lang.String) value.
 void setDataName(java.lang.String dataName)
          Sets the dataName property (java.lang.String) value.
 void setDataToClear(java.lang.String dataToClear)
          Sets the dataToClear property (java.lang.String) value.
 void setDataValue(java.lang.Object dataValue)
          Sets the dataValue property (java.lang.String) value.
 void setHelpID(java.lang.String helpID)
          Sets the helpID property (java.lang.String) value.
 void setNavigationParameters(NavigationParameters navigationParameters)
          Sets the navigationParameters property (com.ibm.dse.gui.NavigationParameters) value.
 void setRequired(boolean required)
          Sets the required property (boolean) value.
 void setSpPanel(SpPanel spPanel)
          Sets the spPanel property (com.ibm.dse.gui.SpPanel) value.
 void setType(java.lang.String type)
          Sets the type property (java.lang.String) value.
 
Methods inherited from class javax.swing.ButtonGroup
getButtonCount, getElements, getSelection, isSelected, remove, setSelected
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SpButtonGroup

public SpButtonGroup()
This constructor creates a SpButtonGroup object.

Method Detail

add

public void add(javax.swing.AbstractButton b)
Adds the button to the group.

Parameters:
b - AbstractButton

addActionListener

public void addActionListener(java.awt.event.ActionListener l)
Documented in the JDK. Complies with the DataExchanger interface.

Specified by:
addActionListener in interface DataExchanger
Parameters:
l - java.awt.event.ActionEvent

addCoordinatedEventListener

public void addCoordinatedEventListener(CoordinatedEventListener newListener)
Adds an CoordinatedEventListener.

Specified by:
addCoordinatedEventListener in interface DataExchanger
Parameters:
newListener - CoordinatedEventListener

addDataChangedListener

public void addDataChangedListener(DataChangedListener newListener)
Deprecated. (use addCoordinatedEventListener(CoordinatedEventListener newListener))

Adds a DataChangedListener.

Specified by:
addDataChangedListener in interface DataExchanger
Parameters:
newListener - DataChangedListener

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Generated to support the propertyChange field.


executeBeanReactions

public void executeBeanReactions(java.awt.Component spRad)
When a Bean changes states and the end state is a non-error state, the Bean will call the beanReaction(java.awt.Component) public static method of the specified class.


fireCoordinationEvent

public void fireCoordinationEvent()
Fires a DSECoordinationEvent when data has changed.


fireCoordinationEvent

public void fireCoordinationEvent(DSECoordinationEvent event)
Fires a DSECoordinationEvent when data has changed.

Parameters:
event - DSECoordinationEvent

fireDataChanged

public void fireDataChanged()
Deprecated. (use fireCoordinationEvent())

Fires a DataChangedEvent when data has changed.


fireHandleDataChanged

public void fireHandleDataChanged(DataChangedEvent event)
Method to support listener events.

Parameters:
event - DataChangedEvent

firePropertyChange

public void firePropertyChange(java.lang.String propertyName,
                               java.lang.Object oldValue,
                               java.lang.Object newValue)
Generated to support the propertyChange field.


getAlternativeDataName

public java.lang.String getAlternativeDataName()
Gets the alternativeDataName property (java.lang.String) value.

Specified by:
getAlternativeDataName in interface DataExchanger
Returns:
The alternativeDataName property value.
See Also:
setAlternativeDataName(java.lang.String)

getBeansReactions

public java.lang.String getBeansReactions()
Gets the beansReactions property (java.lang.String) value.

Returns:
The beansReactions property value.
See Also:
setBeansReactions(java.lang.String)

getDataDirection

public java.lang.String getDataDirection()
Gets the dataDirection property (java.lang.String) value.

Specified by:
getDataDirection in interface DataExchanger
Returns:
String - The dataDirection property value.
See Also:
setDataDirection(java.lang.String)

getDataName

public java.lang.String getDataName()
Gets the dataName property (java.lang.String) value.

Specified by:
getDataName in interface DataExchanger
Returns:
String - The dataName property value.
See Also:
setDataName(java.lang.String)

getDataToClear

public java.lang.String getDataToClear()
Gets the dataToClear property (java.lang.String) value.

Specified by:
getDataToClear in interface PanelActions
Returns:
The dataToClear property value.
See Also:
setDataToClear(java.lang.String)

getDataValue

public java.lang.Object getDataValue()
Gets the dataValue property (java.lang.Object) value.

Specified by:
getDataValue in interface DataExchanger
Returns:
Object - The dataValue property value.
See Also:
setDataValue(java.lang.Object)

getDSECoordinatedPanel

public DSECoordinatedPanel getDSECoordinatedPanel()
Gets the DSECoordinatedPanel where the component is placed

Specified by:
getDSECoordinatedPanel in interface PanelActions
Returns:
com.ibm.dse.gui.DSECoordinatedPanel

getErrorMessage

public java.lang.String getErrorMessage()
Gets the ErrorMessage property value from its formatters (if exists).

Specified by:
getErrorMessage in interface DataExchanger
Returns:
java.lang.String - the error message

getNavigationParameters

public NavigationParameters getNavigationParameters()
Gets the navigationParameters property (com.ibm.dse.gui.NavigationParameters) value.

Specified by:
getNavigationParameters in interface DataExchanger
Returns:
The navigationParameters property value.
See Also:
setNavigationParameters(com.ibm.dse.gui.NavigationParameters)

getPropertyChange

protected java.beans.PropertyChangeSupport getPropertyChange()
Accessor for the propertyChange field.


getRequired

public boolean getRequired()
Gets the required property (boolean) value.

Returns:
boolean - the required property value
See Also:
setRequired(boolean)

getSpPanel

public SpPanel getSpPanel()
Gets the spPanel property (com.ibm.dse.gui.SpPanel) value.

Specified by:
getSpPanel in interface Outsider
Returns:
SpPanel - The spPanel property value.
See Also:
setSpPanel(com.ibm.dse.gui.SpPanel)

getType

public java.lang.String getType()
Gets the type property (java.lang.String) value.

Specified by:
getType in interface DataExchanger
Returns:
The type property value.
See Also:
setType(java.lang.String)

hasAlternativeDataName

public boolean hasAlternativeDataName()
Returns if the SpButtonGroup has alternative data name attribute.

Specified by:
hasAlternativeDataName in interface DataExchanger
Returns:
boolean - if it has alternative data name atribute

isInError

public boolean isInError()
Complies with the DataExchanger interface. A ButtonGroup can never be in error.

Specified by:
isInError in interface DataExchanger
Returns:
boolean - if it is in error or not

isKeyedValue

public boolean isKeyedValue()
if true this bean returns a composed data value.

Specified by:
isKeyedValue in interface DataExchanger
Returns:
boolean

isRequired

public boolean isRequired()
Returns if the ButtonGroup is required or not.

Specified by:
isRequired in interface DataExchanger
Returns:
boolean - if it is required or not

removeActionListener

public void removeActionListener(java.awt.event.ActionListener l)
To comply with DataExchanger interface.

Specified by:
removeActionListener in interface DataExchanger
Parameters:
l - java.awt.event.ActionEvent

removeCoordinatedEventListener

public void removeCoordinatedEventListener(CoordinatedEventListener newListener)
Removes a CoordinatedEventListener.

Specified by:
removeCoordinatedEventListener in interface DataExchanger
Parameters:
newListener - DataChangedListener

removeDataChangedListener

public void removeDataChangedListener(DataChangedListener newListener)
Deprecated. (use removeCoordinatedEventListener(CoordinatedEventListener newListener))

Removes a DataChangedListener.

Specified by:
removeDataChangedListener in interface DataExchanger
Parameters:
newListener - DataChangedListener

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Generated to support the propertyChange field.


setAlternativeDataName

public void setAlternativeDataName(java.lang.String alternativeDataName)
Sets the alternativeDataName property (java.lang.String) value.

Specified by:
setAlternativeDataName in interface DataExchanger
Parameters:
alternativeDataName - The new value for the property.
See Also:
getAlternativeDataName()

setBeansReactions

public void setBeansReactions(java.lang.String beansReactions)
Sets the beansReactions property (java.lang.String) value.

Parameters:
beansReactions - The new value for the property.
See Also:
getBeansReactions()

setDataDirection

public void setDataDirection(java.lang.String dataDirection)
Sets the dataDirection property (java.lang.String) value.

Specified by:
setDataDirection in interface DataExchanger
Parameters:
dataDirection - String, The new value for the property.
See Also:
getDataDirection()

setDataName

public void setDataName(java.lang.String dataName)
Sets the dataName property (java.lang.String) value.

Specified by:
setDataName in interface DataExchanger
Parameters:
dataName - String, The new value for the property.
See Also:
getDataName()

setDataToClear

public void setDataToClear(java.lang.String dataToClear)
Sets the dataToClear property (java.lang.String) value.

Parameters:
dataToClear - The new value for the property.
See Also:
getDataToClear()

setDataValue

public void setDataValue(java.lang.Object dataValue)
Sets the dataValue property (java.lang.String) value.

Specified by:
setDataValue in interface DataExchanger
Parameters:
dataValue - Object, The new value for the property.
See Also:
getDataValue()

setHelpID

public void setHelpID(java.lang.String helpID)
Sets the helpID property (java.lang.String) value.

Specified by:
setHelpID in interface DataExchanger
Parameters:
helpID - String, the new value for the helpID property.

setNavigationParameters

public void setNavigationParameters(NavigationParameters navigationParameters)
Sets the navigationParameters property (com.ibm.dse.gui.NavigationParameters) value.

Specified by:
setNavigationParameters in interface DataExchanger
Parameters:
navigationParameters - The new value for the property.
See Also:
getNavigationParameters()

setRequired

public void setRequired(boolean required)
Sets the required property (boolean) value.

Specified by:
setRequired in interface DataExchanger
Parameters:
required - The new value for the property.
See Also:
getRequired()

setSpPanel

public void setSpPanel(SpPanel spPanel)
Sets the spPanel property (com.ibm.dse.gui.SpPanel) value.

Specified by:
setSpPanel in interface Outsider
Parameters:
spPanel - SpPanel, The new value for the property.
See Also:
getSpPanel()

setType

public void setType(java.lang.String type)
Sets the type property (java.lang.String) value.

Specified by:
setType in interface DataExchanger
Parameters:
type - The new value for the property.
See Also:
getType()

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005