com.ibm.as400.vaccess

Interface VObject

  • All Known Subinterfaces:
    VNode
    All Known Implementing Classes:
    VIFSDirectory, VIFSFile, VJob, VJobList, VJobLogMessage, VMessage, VMessageList, VMessageQueue, VOutput, VPrinter, VPrinterOutput, VPrinters, VQueuedMessage, VSystemPool, VSystemStatus, VSystemValueList, VUser, VUserAndGroup, VUserList
    Deprecated. 
    Use Java Swing instead, along with the classes in package com.ibm.as400.access

    public interface VObject
    The VObject interface defines the representation of an system resource for use in various models and panes in this package.

    An object has any number of properties. These are attributes of the object itself and are identified by property identifiers. Every object has at least name and desctiption properties, and most will define more.

    Many of these methods are not called directly by programs. Instead, they are called by the server panes to respond to the user interface as needed.

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

    VObject objects generate the following events:

    • ErrorEvent
    • VObjectEvent
    • WorkingEvent

    An implementation of this interface should pass on all events fired by its actions and properties pane to its listeners.

    • Field Detail

      • NAME_PROPERTY

        static final java.lang.Object NAME_PROPERTY
        Deprecated. 
        Property identifier for the name.

      • DESCRIPTION_PROPERTY

        static final java.lang.Object DESCRIPTION_PROPERTY
        Deprecated. 
        Property identifier for the description.

    • Method Detail

      • addErrorListener

        void addErrorListener(ErrorListener listener)
        Deprecated. 
        Adds a listener to be notified when an error occurs.
        Parameters:
        listener - The listener.

      • addVObjectListener

        void addVObjectListener(VObjectListener listener)
        Deprecated. 
        Adds a listener to be notified when a VObject is changed, created, or deleted.
        Parameters:
        listener - The listener.

      • addWorkingListener

        void addWorkingListener(WorkingListener listener)
        Deprecated. 
        Adds a listener to be notified when work starts and stops on potentially long-running operations.
        Parameters:
        listener - The listener.

      • getActions

        VAction[] getActions()
        Deprecated. 
        Returns the list of actions that can be performed. This is called when the user brings up a popup menu on this VObject. The popup menu will contain a menu item for each returned VAction.
        Returns:
        The actions, or null if there are no actions.

      • getDefaultAction

        VAction getDefaultAction()
        Deprecated. 
        Returns the default action. This is called when the user double-clicks on this VObject. The returned action will then be performed.
        Returns:
        The default action, or null if there is no default action.

      • getIcon

        javax.swing.Icon getIcon(int size,
                       boolean open)
        Deprecated. 
        Returns the icon. This is called to determine which icon to show with this VObject.
        Parameters:
        size - The icon size, either 16 or 32. If any other value is given, then return a default.
        open - true for the open icon; false for the closed icon. If there is only one icon, then this parameter has no effect.
        Returns:
        The icon, or null if there is none.

      • getPropertiesPane

        VPropertiesPane getPropertiesPane()
        Deprecated. 
        Returns the properties pane. This is called when the user selects the "Properties" menu item on this VObject's popup menu. The return VPropertiesPane object will be presented as a properties dialog.
        Returns:
        The properties pane, or null if there is none.

      • getPropertyValue

        java.lang.Object getPropertyValue(java.lang.Object propertyIdentifier)
        Deprecated. 
        Returns a property value. This is called in order to fill the contents of cells in an AS400DetailsPane or AS400DetailsModel object.

        An implementation of this interface should describe the properties that it supports. At minimum, it should support the following property identifiers:

        Property Return value
        NAME_PROPERTY Returns the VObject itself ("this"). This will be rendered using an icon and a name.
        DESCRIPTION_PROPERTY Returns a text description of the VObject.
        Parameters:
        propertyIdentifier - The property identifier.
        Returns:
        The property value, or null if the property identifier is not recognized.

      • getText

        java.lang.String getText()
        Deprecated. 
        Returns the descriptive text associated with this object. This is called when rendering the VObject in a user interface.
        Returns:
        The descriptive text associated with this object.

      • load

        void load()
        Deprecated. 
        Loads information about the object from the system.

      • removeErrorListener

        void removeErrorListener(ErrorListener listener)
        Deprecated. 
        Removes an error listener.
        Parameters:
        listener - The listener.

      • removeVObjectListener

        void removeVObjectListener(VObjectListener listener)
        Deprecated. 
        Removes a VObjectListener.
        Parameters:
        listener - The listener.

      • removeWorkingListener

        void removeWorkingListener(WorkingListener listener)
        Deprecated. 
        Removes a working listener.
        Parameters:
        listener - The listener.
JTOpen 11.2