com.mindoo.remote.api.com.ibm.rcp.topology
Interface IRemotePage

All Superinterfaces:

IRemoteEclipseWrapper, IRemoteNavigation

public interface IRemotePage
extends IRemoteNavigation, IRemoteEclipseWrapper

Remote API Wrapper for the com.ibm.rcp.topology.Page (Online documentation)

Original documentation:
Interface to a page navigation element. This interface maps to a portal page which is rendered on the client as an Eclipse perspective.

Method Summary

IRemotePage	copy() Creates and returns a copy of the page without any specific context data passed to the page or its components
IRemotePage	copy(java.util.Map pageCtx, java.util.Map criteria, java.util.Map cdata) The copy method is used to create a clone from a given prototype id.
java.lang.String[]	getActivities() This method returns a String array containing the unique identifiers of each Eclipse based activity which should be enabled when this perspective is activated.
java.lang.String[]	getComponents() This method returns a String array containing the unique identifiers of each component which is contained within this navigation element (perspective).
java.lang.String	getDefaultFolder() This method returns the id of the default folder to be used to contain a view which is opened within a perspective programatically.
java.lang.String	getPerspective() This method returns the cached version of the perspective if it exists or the predefined perspective id if the cached perspective is null.
java.lang.String	getPreDefinedPerspective() This method returns the id of the perspective to which this meta data is attached.
java.lang.String	getTheme() This method returns the id of the theme which is to be associated with this perspective.
java.lang.String[]	getWires() This method returns a String array containing the unique identifiers of each wire which should be enabled when this perspective is activated.
boolean	isAutoStart() Returns true or false depending on the autoStart parameter setting which is retrieved from the topology.
boolean	isDirty() Indicates if this page needs to be updated.
boolean	isStatic() Returns true if this page object represents a statically defined page and false if it is a composite application dynamic page.
void	markAsDirty(boolean dirty) Marks this page as being dirty or not.

Methods inherited from interface com.mindoo.remote.api.com.ibm.rcp.topology.IRemoteNavigation

add, contributeToLauncher, copy, getApplication, getId, getImage, getName, getNavigation, getParent, getPreference, getPreferenceKeys, getType, isHidden, remove

Methods inherited from interface com.mindoo.remote.api.IRemoteEclipseWrapper

_internalGetId, equalWrappedObjects

Method Detail

getPerspective

java.lang.String getPerspective()
                                throws RemoteEclipseAPIException

This method returns the cached version of the perspective if it exists or the predefined perspective id if the cached perspective is null. The cached perspective id is the most current version of the perspective.

Returns:

The id of the cached or predefined perspective

Throws:

RemoteEclipseAPIException

getPreDefinedPerspective

java.lang.String getPreDefinedPerspective()
                                          throws RemoteEclipseAPIException

This method returns the id of the perspective to which this meta data is attached. The id is represented as a unique string value. The pre-defined perspective is the original descriptor id created as an extension.

Returns:

The unique ID of the perspective

Throws:

RemoteEclipseAPIException

getTheme

java.lang.String getTheme()
                          throws RemoteEclipseAPIException

This method returns the id of the theme which is to be associated with this perspective. The id is represented as a unique string value.

Returns:

The unique ID of the theme for this perspective

Throws:

RemoteEclipseAPIException

getDefaultFolder

java.lang.String getDefaultFolder()
                                  throws RemoteEclipseAPIException

This method returns the id of the default folder to be used to contain a view which is opened within a perspective programatically. This prevents the view from being placed in the lower left corner of the layout as Eclipse does by default.

Returns:

The unique ID of the folder name to be used as the default

Throws:

RemoteEclipseAPIException

isAutoStart

boolean isAutoStart()
                    throws RemoteEclipseAPIException

Returns true or false depending on the autoStart parameter setting which is retrieved from the topology.

com.ibm.rcp.autoStart = true | false If this value is true then this perspective will be opened when the application is launched.

Returns:

true or false

Throws:

RemoteEclipseAPIException

getActivities

java.lang.String[] getActivities()
                                 throws RemoteEclipseAPIException

This method returns a String array containing the unique identifiers of each Eclipse based activity which should be enabled when this perspective is activated. These activities should also be removed when the perspective is not the active perspective.

Returns:

String array containing each of the activity IDs

Throws:

RemoteEclipseAPIException

getWires

java.lang.String[] getWires()
                            throws RemoteEclipseAPIException

This method returns a String array containing the unique identifiers of each wire which should be enabled when this perspective is activated. These wires should also be disabled when the perspective is not the active perspective.

Returns:

String array containing each of the wire IDs

Throws:

RemoteEclipseAPIException

getComponents

java.lang.String[] getComponents()
                                 throws RemoteEclipseAPIException

This method returns a String array containing the unique identifiers of each component which is contained within this navigation element (perspective).

Returns:

String array containing each component unique ID

Throws:

RemoteEclipseAPIException

isDirty

boolean isDirty()
                throws RemoteEclipseAPIException

Indicates if this page needs to be updated. This will usually incur a perspective rebuild if this flag is set.

Returns:

True if the page is dirty, false otherwise

Throws:

RemoteEclipseAPIException

isStatic

boolean isStatic()
                 throws RemoteEclipseAPIException

Returns true if this page object represents a statically defined page and false if it is a composite application dynamic page.

Returns:

True if static or false otherwise

Throws:

RemoteEclipseAPIException

markAsDirty

void markAsDirty(boolean dirty)
                 throws RemoteEclipseAPIException

Marks this page as being dirty or not. If the page is marked as dirty this means it must be updated when it is next rendered.

Parameters:

dirty - True to mark as dirty false to mark as clean

Throws:

RemoteEclipseAPIException

copy

IRemotePage copy(java.util.Map pageCtx,
                 java.util.Map criteria,
                 java.util.Map cdata)
                 throws RemoteEclipseAPIException

The copy method is used to create a clone from a given prototype id. Context specific data can be passed to the new copy along with its components based on a specified component criteria map.

Parameters:

pageCtx - The new data to be applied to the copied page upon creation, can be null.

criteria - The criteria for the component(s) to have the new preferences set, can be null.

cdata - The new set of preferences for the component on the new page, can be null.

Returns:

The new page copy

Throws:

RemoteEclipseAPIException

copy

IRemotePage copy()
                 throws RemoteEclipseAPIException

Creates and returns a copy of the page without any specific context data passed to the page or its components

Returns:

The new page copy

Throws:

RemoteEclipseAPIException