|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The interface which models a list of system objects.
A ListManager
implementation provides list data to a
user interface, without knowing or caring how the user interface
is implemented.
User interface assumptions:
ListManager
implementations may choose to support
enhanced functions such as sorting or custom toolbars by implementing
the interfaces WindowsListManager
or SortingListManager
.
ActionsManager
,
DropTargetManager
,
WindowsListManager
,
SortingListManager
Field Summary | |
static int |
LIST_CLOSED
Closed status. |
static int |
LIST_COMPLETE
Complete status. |
static int |
LIST_ERROR
Error status. |
static int |
LIST_INCOMPLETE
Incomplete status. |
static int |
OBJECT_HASPROPERTIES
Properties attribute. |
static int |
OBJECT_HASSUBCONTAINERS
Subcontainer attribute. |
static int |
OBJECT_IMPLEMENTSPROPERTIES
Properties implementation attribute. |
static int |
OBJECT_ISCONTAINER
Container attribute. |
static int |
OBJECT_ISDROPTARGET
Drop target attribute. |
static int |
OBJECT_ISGUICONTAINER
GUI container attribute. |
static int |
OBJECT_ISTREELIST
TreeList attribute. |
static int |
OBJECT_OPENEXPANDED
If the object is a folder, indicates that it sould be expanded initially. |
static int |
OBJECT_SELECTED
Selected attribute. |
static int |
SINGLE_SELECTION
Single Selection attribute. |
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 |
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. |
int |
getStatus()
Returns the current status of the list. |
void |
initialize(ObjectName container)
Identifies the container to be enumerated. |
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. |
Field Detail |
public static final int LIST_ERROR
public static final int LIST_INCOMPLETE
public static final int LIST_COMPLETE
public static final int LIST_CLOSED
public static final int OBJECT_ISTREELIST
public static final int OBJECT_OPENEXPANDED
public static final int OBJECT_ISCONTAINER
public static final int OBJECT_ISGUICONTAINER
public static final int OBJECT_HASSUBCONTAINERS
public static final int OBJECT_HASPROPERTIES
public static final int OBJECT_IMPLEMENTSPROPERTIES
public static final int OBJECT_ISDROPTARGET
public static final int OBJECT_SELECTED
public static final int SINGLE_SELECTION
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()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |