|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.as400.opnav.NativeListManager
A class which interfaces with an existing Windows native dll that manages this list.
ListManager
,
WindowsListManager
,
SortingListManager
Fields inherited from interface com.ibm.as400.opnav.ListManager |
LIST_CLOSED,
LIST_COMPLETE,
LIST_ERROR,
LIST_INCOMPLETE,
OBJECT_HASPROPERTIES,
OBJECT_HASSUBCONTAINERS,
OBJECT_IMPLEMENTSPROPERTIES,
OBJECT_ISCONTAINER,
OBJECT_ISDROPTARGET,
OBJECT_ISGUICONTAINER,
OBJECT_ISTREELIST,
OBJECT_OPENEXPANDED,
OBJECT_SELECTED,
SINGLE_SELECTION |
Fields inherited from interface com.ibm.as400.opnav.WindowsListManager |
DEFAULT_ICON,
OPEN_ICON |
Fields inherited from interface com.ibm.as400.opnav.SortingListManager |
SORT_ASCENDING,
SORT_DESCENDING |
Constructor Summary | |
NativeListManager(java.lang.String classID)
Constructs a NativeListManager class which wrappers an OLE IA4HierarchyFolder interface. |
Method Summary | |
void |
close()
Frees all list resources. |
int |
getAttributes(ItemIdentifier item)
Returns the attributes of a list object. |
java.lang.String |
getColumnData(ItemIdentifier item,
int columnID)
Returns the data for a list column. |
ColumnDescriptor[] |
getColumnInfo()
Returns the column headings for this list. |
java.lang.String |
getErrorMessage()
Returns an error message. |
java.lang.String |
getFilterDescription()
Returns a text description of the current include criteria. |
int |
getIconIndex(ItemIdentifier item,
int flags)
Returns the icon index into the plug-in's resource DLL for a list object. |
java.lang.String |
getImageFile(ItemIdentifier item,
int flags)
Returns the image file name for a list object. |
int |
getItemCount()
Returns the total count of objects in the list. |
java.lang.Object |
getListObject(ObjectName objName)
Returns a cached list object. |
java.lang.Object |
getPublicListObject(ObjectName objName)
Returns a public cached list object. |
ColumnDescriptor[] |
getSortingColumnInfo()
Indicates whether multiple sorting is enabled for a list, and which columns it is enabled on. |
int |
getStatus()
Returns the current status of the list. |
WindowsToolBarInfo |
getWindowsToolBarInfo(ObjectName selectedItem)
Returns the toolbar information for a container in the Operations Navigator hierarchy. |
void |
initialize(ObjectName container)
Identifies the container to be enumerated. |
boolean |
isSortingEnabled()
Indicates whether sorting is enabled for a list. |
ItemIdentifier |
itemAt(int index)
Returns the item identifier for a list object. |
void |
open()
Prepares the list for enumeration. |
void |
prepareToExit()
Provides notification that the application is terminating. |
boolean |
sortOnColumn(int columnID,
int sortOrder)
Sorts the list on the specified table column in a view of system objects. |
boolean |
sortOnColumns(ColumnDescriptor[] cd)
Sorts the lists on the specified table column in a view of system objects. |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Constructor Detail |
public NativeListManager(java.lang.String classID)
classID
- The OLE Class ID (CLSID) of the class to be loaded.Method Detail |
public void initialize(ObjectName container)
container
- The container whose contents the user wishes to display.ObjectName
public void open()
getStatus
should return a
value other than LIST_CLOSED
.
open
is called on a data thread so that long running
operations will not degrade the performance of the user interface.
public int getStatus()
public java.lang.String getErrorMessage()
getStatus
has returned
a value of LIST_ERROR
. The returned message should be
in a form suitable for displaying to the user.null
if no error message is available.public int getItemCount()
This method is called after the list has been successfully
opened. If getStatus
returned a value of
LIST_COMPLETE
, this method should return
the total number of objects in the list. If getStatus
returned LIST_INCOMPLETE
, this method should
return the number of objects currently known to be in the list.
public ItemIdentifier itemAt(int index)
This method is called repeatedly when populating the view of a container. Long running operations should be avoided.
index
- the zero-based index of the item for which an
item identifier is requested.ItemIdentifier
public int getAttributes(ItemIdentifier item)
This method is called repeatedly when populating the view of a container. Long running operations should be avoided.
item
- the item identifier for the object whose attributes
are to be retrieved.ItemIdentifier
public java.lang.String getImageFile(ItemIdentifier item, int flags)
This method is called repeatedly when populating the view of a container. Long running operations should be avoided.
item
- the item identifier for the object whose image file
name is to be retrieved.flags
- the constants which reflect the status of the object.ItemIdentifier
public ColumnDescriptor[] getColumnInfo()
ColumnDescriptor
objects
that describe the column headings for this list.ColumnDescriptor
public java.lang.String getColumnData(ItemIdentifier item, int columnID)
This method is called repeatedly when populating the view of a container. Long running operations should be avoided.
item
- the item identifier for the object whose column
data is to be retrieved.columnID
- the numeric ID that identifies the column.ItemIdentifier
public java.lang.Object getListObject(ObjectName objName)
objName
- the name of the object for which a proxy will be retrieved.public void close()
getStatus
should return a
value of LIST_CLOSED
.ObjectName
public void prepareToExit()
public int getIconIndex(ItemIdentifier item, int flags)
Called repeatedly when populating the view of a container. Long running operations should be avoided.
item
- The item identifier for the object whose icon index
is to be retrieved.flags
- A constant which indicates the type of icon requested.ItemIdentifier
public WindowsToolBarInfo getWindowsToolBarInfo(ObjectName selectedItem)
TBButtonDescriptor
s which
contain the control information associated with each toolbar button.WindowsToolBarInfo
.WindowsToolBarInfo
public boolean isSortingEnabled()
ListManager
implementations
delegate to other ListManager
s which may or may not
support sorting.public boolean sortOnColumn(int columnID, int sortOrder)
SortingListManager
implementation
should update its state information indicating the order in which items are
to be sorted. On return from this method, the user interface will immediately
refresh the list by calling ListManager.close
followed by
ListManager.open
.columnID
- the numeric ID identifying the column to sort on, as specified in the column descriptor.sortOrder
- SORT_ASCENDING if the list is to be sorted in ascending order; SORT_DESCENDING
if the list is to be sorted in descending order.ListManager
,
ListManager.getColumnInfo()
public java.lang.Object getPublicListObject(ObjectName objName)
objName
- the name of the object for which a public
object reference will be retrieved.public java.lang.String getFilterDescription()
public ColumnDescriptor[] getSortingColumnInfo()
ColumnDescriptor
objectspublic boolean sortOnColumns(ColumnDescriptor[] cd)
SortingListManager
implementation
should update its state information indicating the order in which columns are
to be sorted. On return from this method, the user interface will immediately
refresh the list by calling ListManager.close
followed by
ListManager.open
. It is assumed that the columns will be sorted
in ascending order.
NOTE: This is currently supported only in the Java Consloe.columns
- The array of the ColumnDescriptors of the columns you want sorted.ListManager
,
ListManager.getColumnInfo()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |