org.vishia.stimuliSelector

Class StimuliSelector.GralUserActionButton

java.lang.Object

org.vishia.gral.ifc.GralUserAction

org.vishia.stimuliSelector.StimuliSelector.GralUserActionButton

Enclosing class:

StimuliSelector

class StimuliSelector.GralUserActionButton
extends GralUserAction

An user action which calls StimuliSelector.execBtnAction(String), assigned to some Buttons. The name in the constructor determines the name of the called subroutine in the JZtxtcmd script.

Field Summary

Fields inherited from class org.vishia.gral.ifc.GralUserAction

name, version

Constructor Summary

Constructors

Constructor and Description
GralUserActionButton(java.lang.String name) Creates

Method Summary

Modifier and Type	Method and Description
boolean	exec(int actionCode, GralWidget_ifc widgd, java.lang.Object... params) This method should be override by the users class.

Methods inherited from class org.vishia.gral.ifc.GralUserAction

toString, userActionGui, userActionGui

Methods inherited from class java.lang.Object

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

Constructor Detail

GralUserActionButton

GralUserActionButton(java.lang.String name)

Creates

Parameters:

name - it is the name of the subroutine in the JZtxtcmd script which will be called.

Method Detail

exec

public boolean exec(int actionCode,
                    GralWidget_ifc widgd,
                    java.lang.Object... params)

Description copied from class: GralUserAction

This method should be override by the users class. In the implementation the user can cast from the widgd given as interface to the known implementation widget type because the GralUserAction is associated to a specific widget.

If this method is not overridden from the GralUserAction super class, it tries to call the deprecated GralUserAction.userActionGui(int, GralWidget, Object...) because that method may be overridden.

Overrides:

exec in class GralUserAction

Parameters:

actionCode - See KeyCode. Any special action is designated with 0.

widgd - The Gral which calls this method in any of its implementation methods. This parameter designates the source of the call with some specific properties in the widget. For example ((GralWidget)widgd).getCmd() can be invoked.

params - Some optional values, depending on special user designation. In most cases no parameter. The user may be test the type of parameter for complex usage.

Returns:

true if execution is succeed. false if the users application can't deal with the actionCode or the widget.