com.ibm.notes.java.ui
Interface NotesUIElement

All Superinterfaces:

IAdaptable

All Known Subinterfaces:

NotesUIDocument, NotesUIView

public interface NotesUIElement
extends IAdaptable

A visual element in the Notes client, such as the contents of a tab. Please note that this interface has only extended IAdaptable since version 8.5.2.

Restriction:

This interface is not intended to be implemented by clients.

Method Summary

void	activate() Give this element focus.
void	addCloseListener(Listener listener) Listen for when this element is closed.
void	close() Closes the element.
String	getTitle() Get the title of the element.
String	getUrl() Get the URL of the element.
IWorkbenchWindow	getWindow() Return the workbench window that holds the element.
void	removeCloseListener(Listener listener) Remove this listener set to listen for the close event.

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Method Detail

getWindow

IWorkbenchWindow getWindow()

Return the workbench window that holds the element. This can be use useful for setting context.

Returns:

the workbench window containing this element

Since:

8.5.1

activate

void activate()

Give this element focus.

Since:

8.5.1

getUrl

String getUrl()

Get the URL of the element.

Returns:

the URL of the element

Since:

8.5.1

close

void close()

Closes the element. If it has been modified, Notes displays a dialog box asking if the user would like to save the changes.

Since:

8.5.1

getTitle

String getTitle()

Get the title of the element.

Returns:

the title of the element

Since:

8.5.1

addCloseListener

void addCloseListener(Listener listener)

Listen for when this element is closed. Calls to methods after this point may cause exceptions or return invalid results.

Parameters:

listener - listener to be notified when the element is closed

Since:

8.5.1

removeCloseListener

void removeCloseListener(Listener listener)

Remove this listener set to listen for the close event.

Parameters:

listener - listener to remove

Since:

8.5.1