org.eclipse.ptp.ui
Interface IElementManager

All Known Subinterfaces:

IJobManager, IMachineManager

All Known Implementing Classes:

AbstractElementManager, JobManager, MachineManager, UIDebugManager

public interface IElementManager

Field Summary

static int	ADD_ELEMENT_TYPE
static int	CHANGE_SET_TYPE
static int	CREATE_SET_TYPE
static int	DELETE_SET_TYPE
static String	EMPTY_ID
static int	REMOVE_ELEMENT_TYPE

Method Summary

void	addSetListener(ISetListener setListener) Add Set Listener
void	addToSet(IElement[] elements, IElementSet set) Add elements to set
void	addToSet(IElement[] elements, String setID, IElementHandler elementHandler) Add elements to set
void	clear() clean all setting
String	createSet(IElement[] elements, String setID, String setName, IElementHandler elementHandler) Create a Set
void	fireSetEvent(int eventType, IElement[] elements, IElementSet cur_set, IElementSet pre_set) Fire Event for set change
String	getCurrentSetId() Get current set ID
IElementHandler	getElementHandler(String id) Get element handler
String	getFullyQualifiedName(String id) Get fully qualified name of element
org.eclipse.swt.graphics.Image	getImage(IElement element) Get element image
String	getName(String id) Get name of element
org.eclipse.ptp.core.elements.IPElement	initial(org.eclipse.ptp.core.elements.IPUniverse universe) initial elements
void	removeElementHandler(String id) Remove the element handler
void	removeFromSet(IElement[] elements, String setID, IElementHandler elementHandler) Remove elements in specific Set
void	removeSet(String setID, IElementHandler elementHandler) Remove Set
void	removeSetListener(ISetListener setListener) Remove Set Listener
void	setCurrentSetId(String set_id) set current set ID
void	setElementHandler(String id, IElementHandler handler) Set element handler
void	shutdown() Shutdown the manager
int	size() Get element size

Field Detail

EMPTY_ID

static final String EMPTY_ID

See Also:

Constant Field Values

CREATE_SET_TYPE

static final int CREATE_SET_TYPE

See Also:

Constant Field Values

DELETE_SET_TYPE

static final int DELETE_SET_TYPE

See Also:

Constant Field Values

CHANGE_SET_TYPE

static final int CHANGE_SET_TYPE

See Also:

Constant Field Values

ADD_ELEMENT_TYPE

static final int ADD_ELEMENT_TYPE

See Also:

Constant Field Values

REMOVE_ELEMENT_TYPE

static final int REMOVE_ELEMENT_TYPE

See Also:

Constant Field Values

Method Detail

addSetListener

void addSetListener(ISetListener setListener)

Add Set Listener

Parameters:

setListener - ISetListener

addToSet

void addToSet(IElement[] elements,
              IElementSet set)

Add elements to set

Parameters:

elements - selected elements

set - Set

addToSet

void addToSet(IElement[] elements,
              String setID,
              IElementHandler elementHandler)

Add elements to set

Parameters:

elements - selected elements

setID - set ID

elementHandler - IElementHandler

clear

void clear()

clean all setting

createSet

String createSet(IElement[] elements,
                 String setID,
                 String setName,
                 IElementHandler elementHandler)

Create a Set

Parameters:

elements - selected elements

setID - set ID

setName - set Name

elementHandler - IElementHandler

Returns:

set ID

fireSetEvent

void fireSetEvent(int eventType,
                  IElement[] elements,
                  IElementSet cur_set,
                  IElementSet pre_set)

Fire Event for set change

Parameters:

eventType - the type of event

elements - the selected elements

cur_set - the current set

pre_set - the previous set

getCurrentSetId

String getCurrentSetId()

Get current set ID

Returns:

current set ID

getElementHandler

IElementHandler getElementHandler(String id)

Get element handler

Parameters:

id - element ID

Returns:

IElementHandler

getFullyQualifiedName

String getFullyQualifiedName(String id)

Get fully qualified name of element

Parameters:

id - element ID

Returns:

fully quallified name of element

getImage

org.eclipse.swt.graphics.Image getImage(IElement element)

Get element image

Parameters:

element - IElement

Returns:

element image

getName

String getName(String id)

Get name of element

Parameters:

id - element ID

Returns:

name of element

initial

org.eclipse.ptp.core.elements.IPElement initial(org.eclipse.ptp.core.elements.IPUniverse universe)

initial elements

Returns:

first element name

removeElementHandler

void removeElementHandler(String id)

Remove the element handler

Parameters:

id - element handler to remove

removeFromSet

void removeFromSet(IElement[] elements,
                   String setID,
                   IElementHandler elementHandler)

Remove elements in specific Set

Parameters:

elements - selected elements

setID - set ID

elementHandler - IElementHandler

removeSet

void removeSet(String setID,
               IElementHandler elementHandler)

Remove Set

Parameters:

setID - set ID

elementHandler - IElementHandler

removeSetListener

void removeSetListener(ISetListener setListener)

Remove Set Listener

Parameters:

setListener - ISetListener

setCurrentSetId

void setCurrentSetId(String set_id)

set current set ID

Parameters:

set_id - set ID

setElementHandler

void setElementHandler(String id,
                       IElementHandler handler)

Set element handler

Parameters:

id - element ID param IElementHandler

shutdown

void shutdown()

Shutdown the manager

size

int size()

Get element size

Returns:

size of element