com.ibm.as400.vaccess
Class VPropertiesAction

java.lang.Object
  |
  +--com.ibm.as400.vaccess.VPropertiesAction
All Implemented Interfaces:
java.io.Serializable, VAction

public class VPropertiesAction
extends java.lang.Object
implements VAction, java.io.Serializable

The VPropertiesAction class is an action that presents a properties pane for an AS/400 resource in a modeless dialog.

If a property dialog is already visible for the object, then it will be given focus.

Most errors are reported as ErrorEvents rather than throwing exceptions. Users should listen for ErrorEvents in order to diagnose and recover from error conditions.

VPropertiesAction objects generate the following events:

See Also:
VPropertiesPane, Serialized Form

Constructor Summary
VPropertiesAction()
          Constructs a VPropertiesAction object.
 
Method Summary
 void addErrorListener(ErrorListener listener)
          Adds a listener to be notified when an error occurs.
 void addVObjectListener(VObjectListener listener)
          Adds a listener to be notified when a VObject is changed, created, or deleted.
 void addWorkingListener(WorkingListener listener)
          Adds a listener to be notified when work starts and stops on potentially long-running operations.
 VObject getObject()
          Returns the object with which the action is associated.
 java.lang.String getText()
          Returns the text for the properties action.
 boolean isEnabled()
          Indicates if the action is enabled.
 void perform(VActionContext context)
          Performs the action.
 void removeErrorListener(ErrorListener listener)
          Removes an error listener.
 void removeVObjectListener(VObjectListener listener)
          Removes a VObjectListener.
 void removeWorkingListener(WorkingListener listener)
          Removes a working listener.
 void setEnabled(boolean enabled)
          Sets the enabled state of the action.
 void setObject(VObject object)
          Sets the object with which the action is associated.
 java.lang.String toString()
          Returns the string representation of the properties action.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

VPropertiesAction

public VPropertiesAction()
Constructs a VPropertiesAction object.
Method Detail

addErrorListener

public void addErrorListener(ErrorListener listener)
Adds a listener to be notified when an error occurs.
Specified by:
addErrorListener in interface VAction
Parameters:
listener - The listener.

addVObjectListener

public void addVObjectListener(VObjectListener listener)
Adds a listener to be notified when a VObject is changed, created, or deleted.
Specified by:
addVObjectListener in interface VAction
Parameters:
listener - The listener.

addWorkingListener

public void addWorkingListener(WorkingListener listener)
Adds a listener to be notified when work starts and stops on potentially long-running operations.
Specified by:
addWorkingListener in interface VAction
Parameters:
listener - The listener.

getObject

public VObject getObject()
Returns the object with which the action is associated.
Returns:
The object.

getText

public java.lang.String getText()
Returns the text for the properties action.
Specified by:
getText in interface VAction
Returns:
The text for the properties action.

isEnabled

public boolean isEnabled()
Indicates if the action is enabled.
Specified by:
isEnabled in interface VAction
Returns:
true if the action is enabled; false otherwise.

perform

public void perform(VActionContext context)
Performs the action.
Specified by:
perform in interface VAction
Parameters:
context - The action context.

removeErrorListener

public void removeErrorListener(ErrorListener listener)
Removes an error listener.
Specified by:
removeErrorListener in interface VAction
Parameters:
listener - The listener.

removeVObjectListener

public void removeVObjectListener(VObjectListener listener)
Removes a VObjectListener.
Specified by:
removeVObjectListener in interface VAction
Parameters:
listener - The listener.

removeWorkingListener

public void removeWorkingListener(WorkingListener listener)
Removes a working listener.
Specified by:
removeWorkingListener in interface VAction
Parameters:
listener - The listener.

setEnabled

public void setEnabled(boolean enabled)
Sets the enabled state of the action.
Specified by:
setEnabled in interface VAction
Parameters:
enabled - true if the action is enabled; false otherwise.

setObject

public void setObject(VObject object)
Sets the object with which the action is associated.
Parameters:
object - The object.

toString

public java.lang.String toString()
Returns the string representation of the properties action.
Overrides:
toString in class java.lang.Object
Returns:
The string representation of the properties action.