ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzahh_5.4.0.1/vmsglist.htm

93 lines
5.2 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en-us" xml:lang="en-us">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="security" content="public" />
<meta name="Robots" content="index,follow" />
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
<meta name="DC.Type" content="reference" />
<meta name="DC.Title" content="VMessageList class" />
<meta name="abstract" content="" />
<meta name="description" content="" />
<meta name="copyright" content="(C) Copyright IBM Corporation 2006" />
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 2006" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="vmsglist" />
<meta name="DC.Language" content="en-us" />
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
<link rel="stylesheet" type="text/css" href="./ic.css" />
<title>VMessageList class</title>
</head>
<body id="vmsglist"><a name="vmsglist"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">VMessageList class</h1>
<div><p></p>
<div class="section"><p>A <a href="javadoc/com/ibm/as400/vaccess/VMessageList.html#NAVBAR_TOP"> VMessageList</a> object is a resource that
represents a list of messages for use in <a href="vpanes.htm#vpanes">AS400Panes</a>.
This is for message lists generated by command or program calls. The following
methods return message lists:</p>
</div>
<div class="section"><ul><li><a href="javadoc/com/ibm/as400/access/CommandCall.html#GETMESSAGELIST()"> CommandCall.getMessageList()</a></li>
<li><a href="javadoc/com/ibm/as400/vaccess/CommandCallButton.html#GETMESSAGELIST()"> CommandCallButton.getMessageList()</a></li>
<li><a href="javadoc/com/ibm/as400/vaccess/CommandCallMenuItem.html#GETMESSAGELIST()"> CommandCallMenuItem.getMessageList()</a></li>
<li><a href="javadoc/com/ibm/as400/access/ProgramCall.html#GETMESSAGELIST()"> ProgramCall.getMessageList()</a></li>
<li><a href="javadoc/com/ibm/as400/vaccess/ProgramCallButton.html#GETMESSAGELIST()"> ProgramCallButton.getMessageList()</a></li>
<li><a href="javadoc/com/ibm/as400/vaccess/ProgramCallMenuItem.html#GETMESSAGELIST()"> ProgramCallMenuItem.getMessageList()</a></li>
</ul>
</div>
<div class="section"><p>To use a VMessageList, set the messageList property. Set this
property by using a constructor or through the <a href="javadoc/com/ibm/as400/vaccess/VMessageList.html#SETMESSAGELIST(COM.IBM.AS400.ACCESS.AS400MESSAGE[])"> setMessageList()</a> method. The VMessageList
object is then "plugged" into the AS400Pane as the root, using the constructor
or setRoot() method of the AS400Pane.</p>
</div>
<div class="section"><p>When AS400Pane and VMessageList objects are created, they are
initialized to a default state. The list of messages is not loaded at creation
time. To load the contents, the caller must explicitly call the load() method
on either object.</p>
</div>
<div class="section"><p>At run-time, a user can perform actions on a message by right-clicking
it to display the context menu. The message context menu can include an item
called <strong>Properties</strong> that displays properties such as the severity,
type, and date.</p>
</div>
<div class="section"><p>The caller can prevent the user from performing actions by using
the setAllowActions() method on the pane.</p>
</div>
<div class="section"><p>The following example creates a VMessageList for the messages
generated by a command call and presents it in an AS400DetailsPane:</p>
</div>
<div class="section"><div class="p"><pre> // Create the VMessageList object.
// Assume that "command" is a
// CommandCall object created and run
// elsewhere.
VMessageList root = new VMessageList (command.getMessageList ());
// Create and load an AS400DetailsPane
// object.
AS400DetailsPane detailsPane = new AS400DetailsPane (root);
detailsPane.load ();
// Add the details pane to a frame.
// Assume that "frame" is a JFrame
// created elsewhere.
frame.getContentPane ().add (detailsPane);</pre>
<strong>Example</strong></div>
</div>
<div class="section"><p>Present the list of messages generated by a command call using
an AS400DetailsPane with a <a href="vmessagelistexample.htm#vmessagelistexample">VMessageList</a> object.
Figure 1 shows the VMessageList graphical user interface component:</p>
</div>
<div class="section"><p><strong>Figure 1: VMessageList GUI component</strong></p>
</div>
<div class="section"><p><img src="rzahh090.gif" alt="VMessageList GUI component" /></p>
</div>
</div>
</body>
</html>