com.ibm.as400.access

Class PanelGroup

  • java.lang.Object
    • com.ibm.as400.access.PanelGroup
  • All Implemented Interfaces:
    java.io.Serializable


    public class PanelGroup
    extends java.lang.Object
    implements java.io.Serializable
    Represents an IBM i panel group (*PNLGRP) object. The help text for a given panel group and set of keywords can be retrieved using the getHelpText method.

    To generate HTML documentation from the panel groups of a given CL command, see the CommandHelpRetriever utility.

    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor and Description
      PanelGroup()
      Constructs a PanelGroup object.
      PanelGroup(AS400 system, java.lang.String path)
      Constructs a PanelGroup object.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
      Adds a PropertyChangeListener.
      PanelGroupHelpIdentifier[] getHelpIdentifiers(java.lang.String[] keywords)
      Returns the panel group help identifiers for the specified keywords.
      java.lang.String getHelpText(java.lang.String[] keywords)
      Retrieves the XML help text from the system for the specified keywords.
      java.lang.String getPath()
      Returns the path name for this panel group.
      AS400 getSystem()
      Returns the system object.
      void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
      Removes the PropertyChangeListener.
      void setPath(java.lang.String path)
      Sets the path name of the panel group.
      void setSystem(AS400 system)
      Sets the system from which to retrieve the panel group.
      java.lang.String toString()
      Returns a String representation for this panel group.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • PanelGroup

        public PanelGroup()
        Constructs a PanelGroup object.
      • PanelGroup

        public PanelGroup(AS400 system,
                  java.lang.String path)
        Constructs a PanelGroup object.
        Parameters:
        system - The system on which the panel group resides.
        path - The fully integrated file system path name of the panel group.
        See Also:
        QSYSObjectPathName
    • Method Detail

      • addPropertyChangeListener

        public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
        Adds a PropertyChangeListener. The specified PropertyChangeListener's propertyChange method will be called each time the value of any bound property is changed. The PropertyChangeListener object is added to a list of PropertyChangeListeners managed by this PanelGroup. It can be removed with removePropertyChangeListener.
        Parameters:
        listener - The PropertyChangeListener.
      • getPath

        public java.lang.String getPath()
        Returns the path name for this panel group.
        Returns:
        The path, or null if no path has been set.
        See Also:
        setPath(java.lang.String)
      • removePropertyChangeListener

        public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
        Removes the PropertyChangeListener. If the PropertyChangeListener is not on the list, nothing is done.
        Parameters:
        listener - The PropertyChangeListener.
      • setPath

        public void setPath(java.lang.String path)
        Sets the path name of the panel group.
        Parameters:
        path - The panel group path.
        See Also:
        getPath()
      • setSystem

        public void setSystem(AS400 system)
        Sets the system from which to retrieve the panel group.
        Parameters:
        system - The system from which to retrieve the panel group.
        See Also:
        getSystem()
      • toString

        public java.lang.String toString()
        Returns a String representation for this panel group.
        Overrides:
        toString in class java.lang.Object
        Returns:
        The string, which includes the fully integrated file system path name of this panel group.