The BTTButton 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:
Button type | Button function |
---|---|
Cancel | Fires a CoordinationEvent. If the Navigation Controller is a listener of the firing BTTCoordinatedComp, then it will cancel the navigation. |
Clear | Clears all data exchangers in the BTTCoordinatedComp and in nested embedded composites whose nesting property is set to true. |
Close | Closes the operation associated with the operation composite, as well as the view where the composite is located. |
Close_Navigation | Fires a CoordinationEvent. If the Navigation Controller is a listener of the firing BTTCoordinatedComp, then Navigation Controller will apply the CloseMapFormat and will close the BTTCoordinatedComp. |
Default | A standard button that does not have associated behavior. |
EMU Currency | When isInEuros in an operation composite is true, converts any data exchangers in the operation composite, and in nested embedded composites whose Euro-EMUConvertible property is set to true, to the currency specified in the EMUCurrency property. |
Euro | When isInEuros in an operation composite is false, converts to euros any data exchangers in the operation composite and in nested embedded composites whose Euro-EMUConvertible property is set to true. |
Execute_Operation | The coordinated composite will execute an operation specified in navigation parameter, and when this operation finishes, the BTTCoordinatedComp fires an "Operation Replied" event. If there are values for the "View Name" and "View Source" parameters, then after the operation executes the composite 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 composite where the button is located. |
Next_View | Fires a CoordinationEvent. If the Navigation Controller is a listener of the firing BTTCoordinatedComp, then it will change the current view to the next view. |
none | A button that does not have associated behavior. |
Ok | Executes the default operation associated with the BTTCoordinatedComp.
It is enabled when all three of the following are true:
|
Open_View | Fires a CoordinationEvent. If the Navigation Controller is a listener of the firing BTTCoordinatedComp, 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 BTTCoordinatedComp that has fired, then it will change the current view to the previous view. |
Repeat | Causes all data exchangers that are located in the BTTCoordinatedComp and in nested embedded composites (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 BTTCoordinatedComp, 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 BTTCoordinatedComp or NavigationController within DSECoordinationEvents and they are used to control the behavior invoked by the button. The following are the parameters:
Parameter | For button types | Description |
---|---|---|
ChainContextTo | Execute_Operation | Used to chain the operation context to a hierarchy. |
CloseMapFormat | Close_Navigation | It may be necessary to save values from the view context to another context before closing the view. In this case, the Composite uses the DataMapperFormat class. |
InputMapFormat | Execute_Operation | 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 composites use the DataMapperFormat class. |
linkContextTo | Next_View Open_View | The context view can be chained to a hierarchy. |
navigation | Next_View Open_View | Used for navigation. Possible String values are peer, children, or none. |
operationName | Execute_Operation | Provides the name of the operation to execute. |
OpenMapFormat | Open_View | It may be necessary to copy values to the view context before opening the view. In this case, the Composite uses the DataMapperFormat class. |
outputMapFormat | Execute_Operation | This property may be necessary to copy values from the operation context to the active after the operation is executed. In this case, the composites 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.