|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.as400.vaccess.VPrinterOutput
The VPrinterOutput class defines the representation of a list of spooled files on an AS/400 for use in various models and panes in this package.
A VPrinterOutput object has no children. Its details children are the spooled files (VOutput objects) in this list.
You must explicitly call load() to load the information from the AS/400.
Most errors are reported as ErrorEvents rather than throwing exceptions. Users should listen for ErrorEvents in order to diagnose and recover from error conditions.
VPrinterOutput objects generate the following events:
SpooledFileList
, Serialized FormFields inherited from interface com.ibm.as400.vaccess.VObject |
DESCRIPTION_PROPERTY, NAME_PROPERTY |
Constructor Summary | |
VPrinterOutput()
Constructs a VPrinterOutput object. |
|
VPrinterOutput(AS400 system)
Constructs a VPrinterOutput object. |
|
VPrinterOutput(VNode parent,
AS400 system)
Constructs a VPrinterOutput object. |
Method Summary | |
void |
addErrorListener(ErrorListener listener)
Adds a listener to be notified when an error occurs. |
void |
addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Adds a listener to be notified when the value of any bound property changes. |
void |
addVetoableChangeListener(java.beans.VetoableChangeListener listener)
Adds a listener to be notified when the value of any constrained property changes. |
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. |
java.util.Enumeration |
children()
Returns the children of the node. |
VAction[] |
getActions()
Returns the list of actions that can be performed. |
boolean |
getAllowsChildren()
Indiciates if the node allows children. |
javax.swing.tree.TreeNode |
getChildAt(int index)
Returns the child node at the specified index. |
int |
getChildCount()
Returns the number of children. |
VAction |
getDefaultAction()
Returns the default action. |
VObject |
getDetailsChildAt(int index)
Returns the child for the details at the specified index. |
int |
getDetailsChildCount()
Returns the number of children for the details. |
javax.swing.table.TableColumnModel |
getDetailsColumnModel()
Returns the table column model to use in the details when representing the children. |
int |
getDetailsIndex(VObject child)
Returns the index of the specified child for the details. |
java.lang.String |
getFormTypeFilter()
Returns the form type filter for the list. |
javax.swing.Icon |
getIcon(int size,
boolean open)
Returns the icon. |
int |
getIndex(javax.swing.tree.TreeNode child)
Returns the index of the specified child. |
javax.swing.tree.TreeNode |
getParent()
Returns the parent node. |
VPropertiesPane |
getPropertiesPane()
Returns the properties pane. |
java.lang.Object |
getPropertyValue(java.lang.Object propertyIdentifier)
Returns a property value. |
java.lang.String |
getQueueFilter()
Returns the output queue list filter. |
AS400 |
getSystem()
Returns the AS/400 on which the output resides. |
java.lang.String |
getText()
Returns the text. |
java.lang.String |
getUserDataFilter()
Returns the user data list filter. |
java.lang.String |
getUserFilter()
Returns the user ID list filter. |
boolean |
isLeaf()
Indicates if the node is a leaf. |
boolean |
isSortable()
Indicates if the details children are sortable. |
void |
load()
Loads information about the object from the AS/400. |
void |
removeErrorListener(ErrorListener listener)
Removes an error listener. |
void |
removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Removes a property change listener. |
void |
removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
Removes a vetoable change listener. |
void |
removeVObjectListener(VObjectListener listener)
Removes a VObjectListener. |
void |
removeWorkingListener(WorkingListener listener)
Removes a working listener. |
void |
setFormTypeFilter(java.lang.String formTypeFilter)
Sets the form type filter for the list. |
void |
setQueueFilter(java.lang.String queueFilter)
Sets the output queue filter. |
void |
setSystem(AS400 system)
Sets the AS/400 on which the output resides. |
void |
setUserDataFilter(java.lang.String userDataFilter)
Sets the user data list filter. |
void |
setUserFilter(java.lang.String userFilter)
Sets the user ID list filter. |
void |
sortDetailsChildren(java.lang.Object[] propertyIdentifiers,
boolean[] orders)
Sorts the children for the details. |
java.lang.String |
toString()
Returns the string representation. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public VPrinterOutput()
public VPrinterOutput(AS400 system)
system
- The AS/400 on which the output resides.public VPrinterOutput(VNode parent, AS400 system)
parent
- The parent.system
- The AS/400 on which the output resides.Method Detail |
public void addErrorListener(ErrorListener listener)
addErrorListener
in interface VObject
listener
- The listener.public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
listener
- The listener.public void addVetoableChangeListener(java.beans.VetoableChangeListener listener)
listener
- The listener.public void addVObjectListener(VObjectListener listener)
addVObjectListener
in interface VObject
listener
- The listener.public void addWorkingListener(WorkingListener listener)
addWorkingListener
in interface VObject
listener
- The listener.public java.util.Enumeration children()
children
in interface javax.swing.tree.TreeNode
public VAction[] getActions()
getActions
in interface VObject
public boolean getAllowsChildren()
getAllowsChildren
in interface javax.swing.tree.TreeNode
public javax.swing.tree.TreeNode getChildAt(int index)
getChildAt
in interface javax.swing.tree.TreeNode
index
- The index.public int getChildCount()
getChildCount
in interface javax.swing.tree.TreeNode
public VAction getDefaultAction()
getDefaultAction
in interface VObject
public VObject getDetailsChildAt(int index)
getDetailsChildAt
in interface VNode
index
- The index.public int getDetailsChildCount()
getDetailsChildCount
in interface VNode
public javax.swing.table.TableColumnModel getDetailsColumnModel()
getDetailsColumnModel
in interface VNode
public int getDetailsIndex(VObject child)
getDetailsIndex
in interface VNode
detailsChild
- The details child.public java.lang.String getFormTypeFilter()
public javax.swing.Icon getIcon(int size, boolean open)
getIcon
in interface VObject
size
- The icon size, either 16 or 32. If any other
value is given, then return the default of 16.open
- This parameter has no effect.public int getIndex(javax.swing.tree.TreeNode child)
getIndex
in interface javax.swing.tree.TreeNode
child
- The child.public javax.swing.tree.TreeNode getParent()
getParent
in interface javax.swing.tree.TreeNode
public VPropertiesPane getPropertiesPane()
getPropertiesPane
in interface VObject
public java.lang.Object getPropertyValue(java.lang.Object propertyIdentifier)
getPropertyValue
in interface VObject
propertyIdentifier
- The property identifier. The choices are
NAME_PROPERTY or DESCRIPTION_PROPERTY.public java.lang.String getQueueFilter()
public AS400 getSystem()
public java.lang.String getText()
getText
in interface VObject
public java.lang.String getUserDataFilter()
public java.lang.String getUserFilter()
public boolean isLeaf()
isLeaf
in interface javax.swing.tree.TreeNode
public boolean isSortable()
isSortable
in interface VNode
public void load()
load
in interface VObject
public void removeErrorListener(ErrorListener listener)
removeErrorListener
in interface VObject
listener
- The listener.public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
listener
- The listener.public void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
listener
- The listener.public void removeVObjectListener(VObjectListener listener)
removeVObjectListener
in interface VObject
listener
- The listener.public void removeWorkingListener(WorkingListener listener)
removeWorkingListener
in interface VObject
listener
- The listener.public void setFormTypeFilter(java.lang.String formTypeFilter) throws java.beans.PropertyVetoException
formTypeFilter
- The form type the spooled file must be to be included
in the list. It cannot be greater than 10 characters.
The value can be any specific value or any of these special values:
java.beans.PropertyVetoException
- If the change is vetoed.public void setQueueFilter(java.lang.String queueFilter) throws java.beans.PropertyVetoException
queueFilter
- The library and output queues on which to list spooled
files. The format of the queueFilter string must be in the
format of /QSYS.LIB/libname.LIB/queuename.OUTQ where
java.beans.PropertyVetoException
- If the change is vetoed.public void setSystem(AS400 system) throws java.beans.PropertyVetoException
system
- The AS/400 on which the output resides.java.beans.PropertyVetoException
- If the change is vetoed.public void setUserDataFilter(java.lang.String userDataFilter) throws java.beans.PropertyVetoException
userDataFilter
- The user data the spooled file must
have for it to be included in the list. The value can be
any specific value or the special value *ALL. The value cannot be
greater than 10 characters.
The default is *ALL.java.beans.PropertyVetoException
- If the change is vetoed.public void setUserFilter(java.lang.String userFilter) throws java.beans.PropertyVetoException
userFilter
- The user or users for which to list spooled files.
The value cannot be greater than 10 characters.
The value can be any specific user ID or any of these special values:
java.beans.PropertyVetoException
- If the change is vetoed.public void sortDetailsChildren(java.lang.Object[] propertyIdentifiers, boolean[] orders)
sortDetailsChildren
in interface VNode
propertyIdentifiers
- The property identifiers.orders
- The sort orders for each property
identifier; true for ascending order,
false for descending order.public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |