|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.ibm.as400.access.PanelGroup
public class PanelGroup extends Object implements 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.
Constructor and Description |
---|
PanelGroup()
Constructs a PanelGroup object. |
PanelGroup(AS400 system,
String path)
Constructs a PanelGroup object. |
Modifier and Type | Method and Description |
---|---|
void |
addPropertyChangeListener(PropertyChangeListener listener)
Adds a PropertyChangeListener. |
PanelGroupHelpIdentifier[] |
getHelpIdentifiers(String[] keywords)
Returns the panel group help identifiers for the specified keywords. |
String |
getHelpText(String[] keywords)
Retrieves the XML help text from the system for the specified keywords. |
String |
getPath()
Returns the path name for this panel group. |
AS400 |
getSystem()
Returns the system object. |
void |
removePropertyChangeListener(PropertyChangeListener listener)
Removes the PropertyChangeListener. |
void |
setPath(String path)
Sets the path name of the panel group. |
void |
setSystem(AS400 system)
Sets the system from which to retrieve the panel group. |
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 |
---|
public PanelGroup()
public PanelGroup(AS400 system, String path)
system
- The system on which the panel group resides.path
- The fully integrated file system path name of the panel group.QSYSObjectPathName
Method Detail |
---|
public void addPropertyChangeListener(PropertyChangeListener listener)
listener
- The PropertyChangeListener.public PanelGroupHelpIdentifier[] getHelpIdentifiers(String[] keywords) throws AS400Exception, AS400SecurityException, ErrorCompletingRequestException, IOException, InterruptedException, ObjectDoesNotExistException
keywords
- An array of keywords for which to retrieve help. The panel group to which
the keywords belong is assumed to be the path of this PanelGroup object.AS400Exception
AS400SecurityException
ErrorCompletingRequestException
IOException
InterruptedException
ObjectDoesNotExistException
public String getHelpText(String[] keywords) throws AS400Exception, AS400SecurityException, ErrorCompletingRequestException, IOException, InterruptedException, ObjectDoesNotExistException
keywords
- An array of keywords for which to retrieve help. The panel group to which
the keywords belong is assumed to be the path of this PanelGroup object.AS400Exception
AS400SecurityException
ErrorCompletingRequestException
IOException
InterruptedException
ObjectDoesNotExistException
public String getPath()
setPath(java.lang.String)
public AS400 getSystem()
setSystem(com.ibm.as400.access.AS400)
public void removePropertyChangeListener(PropertyChangeListener listener)
listener
- The PropertyChangeListener.public void setPath(String path)
path
- The panel group path.getPath()
public void setSystem(AS400 system)
system
- The system from which to retrieve the panel group.getSystem()
public String toString()
toString
in class Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |