JFormDesigner 5.0.4 Runtime API

com.jformdesigner.model
Class FormEvent

java.lang.Object
  extended by com.jformdesigner.model.FormEvent

public class FormEvent
extends java.lang.Object

A form event.

Since:
2.0

Field Summary
static java.lang.String FIELD_HANDLER
           
static java.lang.String FIELD_PASS_PARAMS
           
static java.lang.String FIELD_PROPERTY_NAME
           
 
Constructor Summary
FormEvent(FormEvent orig)
          Copy constructor.
FormEvent(java.lang.String listener, java.lang.String listenerMethod, java.lang.String handler, boolean passParams)
          Constructs a form event.
FormEvent(java.lang.String listener, java.lang.String listenerMethod, java.lang.String handler, boolean passParams, java.lang.String propertyName)
          Constructs a form event.
 
Method Summary
 FormComponent getComponent()
          Returns the form component for this object.
 java.lang.String getHandler()
          Returns the name of the method that the event handler will invoke on the target.
 java.lang.String getListener()
          Returns the name of the listener interface (e.g.
 java.lang.String getListenerMethod()
          Returns the name of the method in the listener interface that should trigger the handler (e.g.
 boolean getPassParams()
          Returns whether the listener method parameters should passed to the handler method.
 java.lang.String getPropertyName()
          Returns the property name used to add PropertyChangeListeners.
 void setHandler(java.lang.String handler)
          Sets the name of the event handler method.
 void setPassParams(boolean passParams)
          Sets whether the listener method parameters should passed to the handler method.
 void setPropertyName(java.lang.String propertyName)
          Sets the property name used to add PropertyChangeListeners.
 java.lang.String toString()
          Returns a string representation of the object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

FIELD_HANDLER

public static final java.lang.String FIELD_HANDLER
See Also:
Constant Field Values

FIELD_PASS_PARAMS

public static final java.lang.String FIELD_PASS_PARAMS
See Also:
Constant Field Values

FIELD_PROPERTY_NAME

public static final java.lang.String FIELD_PROPERTY_NAME
Since:
3.0
See Also:
Constant Field Values
Constructor Detail

FormEvent

public FormEvent(java.lang.String listener,
                 java.lang.String listenerMethod,
                 java.lang.String handler,
                 boolean passParams)
Constructs a form event.

Parameters:
listener - The name of the listener interface (e.g. "java.awt.event.ActionListener").
listenerMethod - The name of the method in the listener interface that should trigger the handler (e.g. "actionPerformed").
handler - The name of the event handler method.
passParams - If true, pass listener method parameters to the handler method.

FormEvent

public FormEvent(java.lang.String listener,
                 java.lang.String listenerMethod,
                 java.lang.String handler,
                 boolean passParams,
                 java.lang.String propertyName)
Constructs a form event.

Parameters:
listener - The name of the listener interface (e.g. "java.awt.event.ActionListener").
listenerMethod - The name of the method in the listener interface that should trigger the handler (e.g. "actionPerformed").
handler - The name of the event handler method.
passParams - If true, pass listener method parameters to the handler method.
propertyName - The property name used to add PropertyChangeListeners.
Since:
3.0

FormEvent

public FormEvent(FormEvent orig)
Copy constructor.

Method Detail

getListener

public java.lang.String getListener()
Returns the name of the listener interface (e.g. "java.awt.event.ActionListener").


getListenerMethod

public java.lang.String getListenerMethod()
Returns the name of the method in the listener interface that should trigger the handler (e.g. "actionPerformed").


getHandler

public java.lang.String getHandler()
Returns the name of the method that the event handler will invoke on the target.


setHandler

public void setHandler(java.lang.String handler)
Sets the name of the event handler method.


getPassParams

public boolean getPassParams()
Returns whether the listener method parameters should passed to the handler method.


setPassParams

public void setPassParams(boolean passParams)
Sets whether the listener method parameters should passed to the handler method.


getPropertyName

public java.lang.String getPropertyName()
Returns the property name used to add PropertyChangeListeners.

Since:
3.0

setPropertyName

public void setPropertyName(java.lang.String propertyName)
Sets the property name used to add PropertyChangeListeners.

Since:
3.0

getComponent

public FormComponent getComponent()
Returns the form component for this object.


toString

public java.lang.String toString()
Returns a string representation of the object.

Overrides:
toString in class java.lang.Object

JFormDesigner 5.0.4 Runtime API

Copyright (C) 2004-2012 FormDev Software GmbH. All rights reserved.