Eclipse RSE Development Guide (Galileo) - ISystemResourceChangeEvents (RSE API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

RSE
Release 3.0

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.rse.core.events
Interface ISystemResourceChangeEvents

public interface ISystemResourceChangeEvents

Interface of event ID constants

Field Summary

static int EVENT_ADD
          The event is a resource add.

static int EVENT_ADD_FILTER_REFERENCE
          The event is specifically a filter reference add (filter added) An ISystemFilter is expected as a parameter of this event

static int EVENT_ADD_FILTERSTRING_REFERENCE
          The event is specifically a filter string reference add (filterstring added) An ISystemFilterString is expected as a parameter of this event

static int EVENT_ADD_MANY
          The event is a multi-resource add.

static int EVENT_ADD_RELATIVE
          The event is a resource add.

static int EVENT_CHANGE_CHILDREN
          The event is a generic notification that the children have changed and must be refreshed.

static int EVENT_CHANGE_FILTER_REFERENCE
          The event is specifically a filter reference change (filter strings changes) An ISystemFilter is expected as a parameter of this event

static int EVENT_CHANGE_FILTERSTRING_REFERENCE
          The event is specifically a filter string reference change (filterstring changed) An ISystemFilterString is expected as a parameter of this event

static int EVENT_COLLAPSE_ALL
          The event is a full collapse of the RSE tree Pass "false" for the src value to prevent the memory flush, else pass any dummy value for the src to prevent crash, but it is ignored

static int EVENT_COLLAPSE_SELECTED
          The event is a collapse of the selected elements in the tree Pass any dummy value for the src to prevent crash, but it is ignored

static int EVENT_COMMAND_FINISHED
          Deprecated. use EVENT_COMMAND_SHELL_FINISHED

static int EVENT_COMMAND_HISTORY_UPDATE
          The event is to update the command history drop-down in the remote shell view A source RSE object is the expected parameter TODO should be moved out of core since this is command-specific

static int EVENT_COMMAND_MESSAGE
          The event is to log a message from a command that has been run A source RSE object and it's parent RSE object are the expected parameters

static int EVENT_COMMAND_RUN
          The event is to log a command that has been run A source RSE object is the expected parameter

static int EVENT_COMMAND_SHELL_FINISHED
          The event is to update the remote shell view when a command is finished A source RSE object is the expected parameter

static int EVENT_COMMAND_SHELL_REMOVED
          The event is to indicate that a shell has been removed A source RSE object is the expected parameter

static int EVENT_COMPILE_COMMAND_RUN
          Deprecated.

static int EVENT_DELETE
          The event is a single resource deletion.

static int EVENT_DELETE_FILTER_REFERENCE
          The event is specifically a filter reference delete (filter deleted) An ISystemFilter is expected as a parameter of this event

static int EVENT_DELETE_FILTERSTRING_REFERENCE
          The event is specifically a filter string reference delete (filterstring deleted) An ISystemFilterString is expected as a parameter of this event

static int EVENT_DELETE_MANY
          The event is a multiple resource deletion.

static int EVENT_EXPAND_SELECTED
          The event is an expand of the selected elements in the tree Pass any dummy value for the src to prevent crash, but it is ignored

static int EVENT_ICON_CHANGE
          The event is an icon change event A source RSE object or an array of source RSE objects and the parent RSE object are the expected parameters

static int EVENT_MOVE_FILTER_REFERENCES
          The event is specifically a filter reference move (filters reordered) An array of ISystemFilter[] is the expected multi-source parameter.

static int EVENT_MOVE_FILTERSTRING_REFERENCES
          The event is specifically a filter string reference move (filterstrings reordered) An array of ISystemFilterString[] is the expected multi-source parameter.

static int EVENT_MOVE_MANY
          The event is a multiple resource move within the same children set An array of RSE objects (i.e.

static int EVENT_MUST_COLLAPSE
          The event is a resource property change that invalidates child nodes in the GUI (eg, hostname change means the expanded information should be collapsed) A source RSE object is the expected parameter

static int EVENT_PROPERTY_CHANGE
          The event is a resource property change.

static int EVENT_PROPERTYSHEET_UPDATE
          The event is a request to update the property sheet of whatever is currently selected.

static int EVENT_REFRESH
          Refresh the single item passed in the "source" field of the event.

static int EVENT_REFRESH_REMOTE
          Refresh a remote object in the SystemView, given either the remote object or a string that will match on getAbsoluteName, and optionally (re)select a list of objects after refreshing.

static int EVENT_REFRESH_SELECTED
          Deprecated. obtain the selection yourself and do EVENT_REFRESH or EVENT_REFRESH_REMOTE

static int EVENT_REFRESH_SELECTED_FILTER
          Deprecated. Refreshing a particular context(filter) only can lead to inconsistencies, so better obtain the selection yourself and do EVENT_REFRESH or EVENT_REFRESH_REMOTE

static int EVENT_REFRESH_SELECTED_PARENT
          Deprecated. obtain the selection yourself and do EVENT_REFRESH or EVENT_REFRESH_REMOTE

static int EVENT_RENAME
          The event is a resource rename.

static int EVENT_RENAME_FILTER_REFERENCE
          The event is specifically a filter reference rename (filter renamed) An ISystemFilter is expected as a parameter of this event

static int EVENT_REPLACE_CHILDREN
          The event is to replace the children (similar to EVENT_ADD_MANY), it will expand also An array of RSE objects (i.e.

static int EVENT_REVEAL_AND_SELECT
          After an add, you wish to expand the parent to reveal and select the new child.

static int EVENT_SEARCH_FINISHED
          The event is to update the search view when a search is finished A IHostSearchResultConfiguration is the expected parameter

static int EVENT_SELECT
          The event is simply to force selection of the given object.

static int EVENT_SELECT_EXPAND
          The event is to both select and expand the given object.

static int EVENT_SELECT_REMOTE
          Select one or more remote objects.

static ISystemResourceChangeEvent PROPERTYSHEET_UPDATE_EVENT
          Predefined event object for a property sheet update.

Field Detail

EVENT_ADD_FILTER_REFERENCE

static final int EVENT_ADD_FILTER_REFERENCE

The event is specifically a filter reference add (filter added) An ISystemFilter is expected as a parameter of this event

See Also:: Constant Field Values

EVENT_RENAME_FILTER_REFERENCE

static final int EVENT_RENAME_FILTER_REFERENCE

The event is specifically a filter reference rename (filter renamed) An ISystemFilter is expected as a parameter of this event

See Also:: Constant Field Values

EVENT_DELETE_FILTER_REFERENCE

static final int EVENT_DELETE_FILTER_REFERENCE

The event is specifically a filter reference delete (filter deleted) An ISystemFilter is expected as a parameter of this event

See Also:: Constant Field Values

EVENT_CHANGE_FILTER_REFERENCE

static final int EVENT_CHANGE_FILTER_REFERENCE

The event is specifically a filter reference change (filter strings changes) An ISystemFilter is expected as a parameter of this event

See Also:: Constant Field Values

EVENT_MOVE_FILTER_REFERENCES

static final int EVENT_MOVE_FILTER_REFERENCES

The event is specifically a filter reference move (filters reordered) An array of ISystemFilter[] is the expected multi-source parameter. The source is the first item in that array.

See Also:: Constant Field Values

EVENT_ADD_FILTERSTRING_REFERENCE

static final int EVENT_ADD_FILTERSTRING_REFERENCE

The event is specifically a filter string reference add (filterstring added) An ISystemFilterString is expected as a parameter of this event

See Also:: Constant Field Values

EVENT_DELETE_FILTERSTRING_REFERENCE

static final int EVENT_DELETE_FILTERSTRING_REFERENCE

The event is specifically a filter string reference delete (filterstring deleted) An ISystemFilterString is expected as a parameter of this event

See Also:: Constant Field Values

EVENT_CHANGE_FILTERSTRING_REFERENCE

static final int EVENT_CHANGE_FILTERSTRING_REFERENCE

The event is specifically a filter string reference change (filterstring changed) An ISystemFilterString is expected as a parameter of this event

See Also:: Constant Field Values

EVENT_MOVE_FILTERSTRING_REFERENCES

static final int EVENT_MOVE_FILTERSTRING_REFERENCES

The event is specifically a filter string reference move (filterstrings reordered) An array of ISystemFilterString[] is the expected multi-source parameter. The source is the first item in that array.

See Also:: Constant Field Values

EVENT_ADD

static final int EVENT_ADD

The event is a resource add. Any RSE object is the expected parameter

See Also:: Constant Field Values

EVENT_ADD_MANY

static final int EVENT_ADD_MANY

The event is a multi-resource add. An array of RSE objects (i.e. Object[]) is the multi-source parameter (the source is the first item in that array) and a parent RSE object is expected.

See Also:: Constant Field Values

EVENT_ADD_RELATIVE

static final int EVENT_ADD_RELATIVE

The event is a resource add. The resource is added relative to the "previous" attribute . The expected parameters are an RSE object and it's parent RSE object

See Also:: Constant Field Values

EVENT_REVEAL_AND_SELECT

static final int EVENT_REVEAL_AND_SELECT

After an add, you wish to expand the parent to reveal and select the new child. This is a harmless operation if the parent was already expanded when EVENT_ADD was sent. The expected parameters are an RSE object and the selected object

See Also:: Constant Field Values

EVENT_DELETE

static final int EVENT_DELETE

The event is a single resource deletion. An RSE object is the expected parameter

See Also:: Constant Field Values

EVENT_DELETE_MANY

static final int EVENT_DELETE_MANY

The event is a multiple resource deletion. An array of RSE objects (i.e. Object[]) is the expected multi-source parameter. The source is the first item in that array.

See Also:: Constant Field Values

EVENT_RENAME

static final int EVENT_RENAME

The event is a resource rename. An RSE object is the expected parameter

See Also:: Constant Field Values

EVENT_MOVE_MANY

static final int EVENT_MOVE_MANY

The event is a multiple resource move within the same children set An array of RSE objects (i.e. Object[]) is the multi-source parameter (the source is the first item in that array) and a parent RSE object is expected.

See Also:: Constant Field Values

EVENT_ICON_CHANGE

static final int EVENT_ICON_CHANGE

The event is an icon change event A source RSE object or an array of source RSE objects and the parent RSE object are the expected parameters

Since:: 3.1 an array of source RSE objects is allowed
See Also:: Constant Field Values

EVENT_REFRESH

static final int EVENT_REFRESH

Refresh the single item passed in the "source" field of the event. All expanded sub-nodes are re-queried for their children, unexpanded nodes lose their children cache. Selection is not maintained by this event (use EVENT_REFRESH_REMOTE instead to maintain the selection). A source RSE object to refresh is the expected parameter

See Also:: Constant Field Values

EVENT_REFRESH_SELECTED

static final int EVENT_REFRESH_SELECTED

Deprecated. obtain the selection yourself and do EVENT_REFRESH or EVENT_REFRESH_REMOTE

Refresh the items currently selected in the SystemView. All expanded sub-nodes are re-queried for their children, unexpanded nodes lose their children cache. After refreshing, selection of the currently selected elements is restored if possible (in case an absoluteName is available). In case any of the selected items is a leaf node, the parent of that leaf node is refreshed rather than the leaf node itself. In this particular case, a multiselect is not considered properly. The SystemScratchpadView also listens to this event and refreshes those elements that are selected in it.

See Also:: Constant Field Values

EVENT_REFRESH_SELECTED_PARENT

static final int EVENT_REFRESH_SELECTED_PARENT

Deprecated. obtain the selection yourself and do EVENT_REFRESH or EVENT_REFRESH_REMOTE

Refresh the parent of the first item currently selected in the SystemView. This only refreshes the parent TreeItem of the first item in the selection. It does not consider multiselect, multiple occurrences of the Item under multiple filters, and does not maintain the current selection.

See Also:: Constant Field Values

EVENT_REFRESH_SELECTED_FILTER

static final int EVENT_REFRESH_SELECTED_FILTER

Deprecated. Refreshing a particular context(filter) only can lead to inconsistencies, so better obtain the selection yourself and do EVENT_REFRESH or EVENT_REFRESH_REMOTE

Refresh the filter under which the first item currently selected in the SystemView is found. From the filter level, all expanded sub-nodes are re-queried for their children, unexpanded nodes lose their children cache. After refreshing, selection of the currently selected elements is restored if possible. Multiselect is not considered properly.

See Also:: Constant Field Values

EVENT_REFRESH_REMOTE

static final int EVENT_REFRESH_REMOTE

Refresh a remote object in the SystemView, given either the remote object or a string that will match on getAbsoluteName, and optionally (re)select a list of objects after refreshing. An object is considered remote if it has an adapter that implements ISystemViewElementAdapter where the adapter returns true for the isRemote(Object) call. This method refreshes all occurrences of the remote object, even under multiple filters. The tricky part about remote objects is their actual memory object changes on each refresh, so to find one in the tree we must use something more permanent: hence the use of getAbsoluteName to find it.

You can optionally pass a child remote object, or string, or Vector of objects or strings, in the "parent" parameter of the event, and it/they will be selected after the refresh. When passing a string, it must be the result of IRemoteObjectIdentifier.getAbsoluteName(Object) on the adapter. A remote RSE object is the expected source parameter

See Also:: Constant Field Values

EVENT_PROPERTY_CHANGE

static final int EVENT_PROPERTY_CHANGE

The event is a resource property change. A source RSE object and it's parent RSE object are the expected parameters

See Also:: Constant Field Values

EVENT_PROPERTYSHEET_UPDATE

static final int EVENT_PROPERTYSHEET_UPDATE

The event is a request to update the property sheet of whatever is currently selected. A source RSE object and it's parent RSE object are the expected parameters

See Also:: Constant Field Values

EVENT_MUST_COLLAPSE

static final int EVENT_MUST_COLLAPSE

The event is a resource property change that invalidates child nodes in the GUI (eg, hostname change means the expanded information should be collapsed) A source RSE object is the expected parameter

See Also:: Constant Field Values

EVENT_COLLAPSE_ALL

static final int EVENT_COLLAPSE_ALL

The event is a full collapse of the RSE tree Pass "false" for the src value to prevent the memory flush, else pass any dummy value for the src to prevent crash, but it is ignored

See Also:: Constant Field Values

EVENT_COLLAPSE_SELECTED

static final int EVENT_COLLAPSE_SELECTED

The event is a collapse of the selected elements in the tree Pass any dummy value for the src to prevent crash, but it is ignored

See Also:: Constant Field Values

EVENT_EXPAND_SELECTED

static final int EVENT_EXPAND_SELECTED

The event is an expand of the selected elements in the tree Pass any dummy value for the src to prevent crash, but it is ignored

See Also:: Constant Field Values

EVENT_CHANGE_CHILDREN

static final int EVENT_CHANGE_CHILDREN

The event is a generic notification that the children have changed and must be refreshed. A source RSE object and (optionally) it's parent RSE object are the expected parameters

See Also:: Constant Field Values

EVENT_SELECT

static final int EVENT_SELECT

The event is simply to force selection of the given object. A source RSE object is the expected parameter

See Also:: Constant Field Values

EVENT_SELECT_REMOTE

static final int EVENT_SELECT_REMOTE

Select one or more remote objects. The "src" parameter holds a remote object, or string, or Vector of objects or strings. When passing a string, it must be the result of IRemoteObjectIdentifier.getAbsoluteName(Object) on the adapter of the object. The "parent" parameter can optionally hold a model object that is the parent of the objects to be refreshed, in order to optimize searches.

See Also:: Constant Field Values

EVENT_SELECT_EXPAND

static final int EVENT_SELECT_EXPAND

The event is to both select and expand the given object. A source RSE object is the expected parameter

See Also:: Constant Field Values

EVENT_COMMAND_RUN

static final int EVENT_COMMAND_RUN

The event is to log a command that has been run A source RSE object is the expected parameter

See Also:: Constant Field Values

EVENT_COMMAND_MESSAGE

static final int EVENT_COMMAND_MESSAGE

The event is to log a message from a command that has been run A source RSE object and it's parent RSE object are the expected parameters

See Also:: Constant Field Values

EVENT_REPLACE_CHILDREN

static final int EVENT_REPLACE_CHILDREN

The event is to replace the children (similar to EVENT_ADD_MANY), it will expand also An array of RSE objects (i.e. Object[]) is the multi-source parameter (the source is the first item in that array) and a parent RSE object is expected.

See Also:: Constant Field Values

EVENT_COMPILE_COMMAND_RUN

static final int EVENT_COMPILE_COMMAND_RUN

Deprecated.

The event is to log a command that has been run

See Also:: Constant Field Values

EVENT_COMMAND_HISTORY_UPDATE

static final int EVENT_COMMAND_HISTORY_UPDATE

The event is to update the command history drop-down in the remote shell view A source RSE object is the expected parameter TODO should be moved out of core since this is command-specific

See Also:: Constant Field Values

EVENT_COMMAND_FINISHED

static final int EVENT_COMMAND_FINISHED

Deprecated. use EVENT_COMMAND_SHELL_FINISHED

The event is to update the remote shell view when a command is finished

See Also:: Constant Field Values

EVENT_COMMAND_SHELL_FINISHED

static final int EVENT_COMMAND_SHELL_FINISHED

The event is to update the remote shell view when a command is finished A source RSE object is the expected parameter

See Also:: Constant Field Values

EVENT_COMMAND_SHELL_REMOVED

static final int EVENT_COMMAND_SHELL_REMOVED

The event is to indicate that a shell has been removed A source RSE object is the expected parameter

See Also:: Constant Field Values

EVENT_SEARCH_FINISHED

static final int EVENT_SEARCH_FINISHED

The event is to update the search view when a search is finished A IHostSearchResultConfiguration is the expected parameter

See Also:: Constant Field Values

PROPERTYSHEET_UPDATE_EVENT

static final 
ISystemResourceChangeEvent PROPERTYSHEET_UPDATE_EVENT

Predefined event object for a property sheet update.