Button

The SpButton bean provides a set of different button types, each of which initiates a particular behavior when clicked. Depending on the type of button, the function of the button is one of the following:

Table 1. Button type and function
Button type Button function
Cancel Fires a CoordinationEvent. If the Navigation Controller is a listener of the firing DSECoordinatedPanel, then it will cancel the navigation.
Clear Clears all data exchangers in the DSECoordinatedPanel and in nested embedded panels whose nesting property is set to true.
Close Closes the operation associated with the operation panel, as well as the view where the panel is located.
Cancel_Navigation Fires a CoordinationEvent. If the Navigation Controller is a listener of the firing DSECoordinatedPanel, then Navigation Controller will apply the CloseMapFormat and will close the DSECoordinatedPanel.
Default A standard button that does not have associated behavior.
EMUCurrency Converts any data exchangers in the operation panel, and in nested embedded panels whose Euro-EMUConvertible property is set to true, to the currency specified in the EMUCurrency property.
Euro Converts to euros any data exchangers in the operation panel and in nested embedded panels whose Euro-EMUConvertible property is set to true.
ExecuteOperation The coordinated panel will execute a specific operation, and when this operation finishes, the DSECoordinatedPanel fires an "Operation Replied" event. If there is a value for the "View Information" parameter, then after the operation executes the panel will fire a "Next View" event.
Help Calls the showHelp(String HelpId) method defined in the class specified in the classForHelpImplementation property. The helpId argument is the help identifier associated with the panel where the button is located.
Next View Fires a CoordinationEvent. If the Navigation Controller is a listener of the firing DSECoordinatedPanel, then it will change the current view to the next view.
None Fires a CoordinationEvent. If the Navigation Controller is a listener of the firing DSECoordinatedPanel, then it will send this event to the Flow Processor.
OK Executes the default operation associated with the DSECoordinatedPanel. It is enabled when all three of the following are true:
  • All mandatory fields in the DSECoordinatedPanel and in all nested embedded panels (with nesting property set to true) are filled.
  • No field in the DSECoordinatedPanel and in any nested embedded panel (with nesting property set to true) has a wrong value.
  • Global validations have been successfully performed.
An OK button should be unique on a DSECoordinatedPanel, although it can be located in either the DSECoordinatedPanel or an EmbeddedPanel.
Open View Fires a CoordinationEvent. If the Navigation Controller is a listener of the firing DSECoordinatedPanel, then it will open a new view, and this new view will be the current view.
Previous View Fires a CoordinationEvent. If the Navigation Controller is a listener of the DSECoordinatedPanel that has fired, then it will change the current view to the previous view.
Repeat Causes all data exchangers that are located in the DSECoordinatedPanel and in nested embedded panels (with nesting property set to true), if they have an associated DataName, to take the same values they had in the last operation execution.
Undo Fires a CoordinationEvent. If the Navigation Controller is a listener of the firing DSECoordinatedPanel, then it will change its state to the last committed state.

Each button has the same set of parameters, but the set of parameters that is actually used by the button depends on the button's type. These parameters are passed to the DSECoordinatedPanel or NavigationController within DSECoordinationEvents and they are used to control the behavior invoked by the button. The following are the parameters:

Table 2. Button parameters
Parameter For button types Description
ChainContext executeOperation Used to chain the operation context to the active context.
CloseMapFormat Cancel_Navigation Used in the Desktop. It may be necessary to save values from the view context to another context before closing the view. In this case, the Desktop uses the DataMapperFormat class.
inputFormat executeOperation This property may be necessary to copy values from the active context to the operation context before execution of the operation. In this case, the panels use the DataMapperFormat class.
linkContextTo Next_View Open_View Used in the Desktop. The context view can be chained to a hierarchy.
navigation Next_View Open_View Used in the Desktop for navigation. Possible String values are peer, children, or none.
operationName Execute_Operation Provides the name of the operation to execute.
OpenMapFormat Open_View Used in the Desktop. It may be necessary to copy values to the view context before opening the view. In this case, the Desktop uses the DataMapperFormat class.
outputFormat Execute_Operation This property may be necessary to copy values from the active context to the operation context after the operation is executed. In this case, the panels use the DataMapperFormat class.
View Information Next_View Open_View View identifier for navigation.

When the button is clicked, a DSECoordinationEvent is fired, and the event gets its information from the "type" and "navigationParameters" of the button (see Button properties). The event name is the bean name (getName() method) with ".actionPerformed" appended to it.