com.mindoo.remote.api.com.ibm.notes.java.ui
Interface IRemoteNotesUIElement

All Superinterfaces:
IRemoteAdaptable, IRemoteEclipseWrapper
All Known Subinterfaces:
IRemoteNotesUIDocument, IRemoteNotesUIView

public interface IRemoteNotesUIElement
extends IRemoteAdaptable

Remote API Wrapper for the com.ibm.notes.java.ui.NotesUIElement (Online documentation)

Original documentation:
A visual element in the Notes client, such as the contents of a tab.


Method Summary
 void activate()
          Give this element focus.
 void close()
          Closes the element.
 java.lang.String getTitle()
          Get the title of the element.
 java.lang.String getUrl()
          Get the URL of the element.
 IRemoteWorkbenchWindow getWindow()
          Return the workbench window that holds the element.
 
Methods inherited from interface com.mindoo.remote.api.IRemoteEclipseWrapper
_internalGetId, equalWrappedObjects
 

Method Detail

getWindow

IRemoteWorkbenchWindow getWindow()
                                 throws RemoteEclipseAPIException
Return the workbench window that holds the element. This can be use useful for setting context.

Returns:
the workbench window containing this element
Throws:
RemoteEclipseAPIException

activate

void activate()
              throws RemoteEclipseAPIException
Give this element focus.

Throws:
RemoteEclipseAPIException

getUrl

java.lang.String getUrl()
                        throws RemoteEclipseAPIException
Get the URL of the element.

Returns:
the URL of the element
Throws:
RemoteEclipseAPIException

close

void close()
           throws RemoteEclipseAPIException
Closes the element. If it has been modified, Notes displays a dialog box asking if the user would like to save the changes.

Throws:
RemoteEclipseAPIException

getTitle

java.lang.String getTitle()
                          throws RemoteEclipseAPIException
Get the title of the element.

Returns:
the title of the element
Throws:
RemoteEclipseAPIException