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

All Superinterfaces:

IRemoteEclipseWrapper

All Known Subinterfaces:

IRemotePage

public interface IRemoteNavigation
extends IRemoteEclipseWrapper

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

Original documentation:
Represents a navigation-element as described in WebSphere Portal topology. A Navigation object can be a label, page or a native application. Each navigation element is described in the navigation tree of the topology xml descriptor.

This interface is not intended to be implemented by clients.

Method Summary

void	add(IRemoteNavigation child) Adds a child Navigation object to this Navigation object.
boolean	contributeToLauncher() Returns true or false depending on the launcher parameter setting which is retrieved from the topology.
IRemoteNavigation	copy(boolean recursive) Creates a copy of the navigation element
java.lang.String	getApplication() Returns the unique ID of the application that this navigation element is associated with.
java.lang.String	getId() Returns the unique id associated with this navigation element.
java.lang.String	getImage() This method returns the image file path for the page or label to be used within the user interface layer.
java.lang.String	getName() Returns the displayable name of this Navigation object as a localized String.
IRemoteNavigation[]	getNavigation() This method returns the child navigation elements for this element.
java.lang.String	getParent() Returns the unique id of the parent navigation element for this Navigation object.
java.lang.String[]	getPreference(java.lang.String key) Returns an arbitrary preference set within the context of this Navigation object.
java.lang.String[]	getPreferenceKeys() Returns an array of all attribute keys for this navigation element.
java.lang.String	getType() Returns the type of navigation element.
boolean	isHidden() This method returns a boolean indicating whether or not this navigation element is visible to end users and is renderable in the UI.
void	remove(IRemoteNavigation child) Removes a child Navigation object from this Navigation object.

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

_internalGetId, equalWrappedObjects

Method Detail

getId

java.lang.String getId()
                       throws RemoteEclipseAPIException

Returns the unique id associated with this navigation element. A navigation element id is provided from the Topology xml navigation-element's object-id attribute.

Returns:

A string containing the unique id of the element

Throws:

RemoteEclipseAPIException

getParent

java.lang.String getParent()
                           throws RemoteEclipseAPIException

Returns the unique id of the parent navigation element for this Navigation object. The id maps to the parent-ref attribute in the Topology xml document.

Returns:

A string containing the unique id of this node's parent.

Throws:

RemoteEclipseAPIException

getNavigation

IRemoteNavigation[] getNavigation()
                                  throws RemoteEclipseAPIException

This method returns the child navigation elements for this element. Navigation elements can be nested and can be either navigable pages or labels.

Returns:

An array of child navigation element objects

Throws:

RemoteEclipseAPIException

getName

java.lang.String getName()
                         throws RemoteEclipseAPIException

Returns the displayable name of this Navigation object as a localized String.

Returns:

The localized name of the Navigation

Throws:

RemoteEclipseAPIException

getType

java.lang.String getType()
                         throws RemoteEclipseAPIException

Returns the type of navigation element. The navigation type can be one of the following:
TYPE_LABEL TYPE_PERSPECTIVE TYPE_NATIVE_APP Labels are not rendered as user pages, but are used by the user interface layer to determine if a page should be inside of a navigation folder or 'page group'.

Returns:

The type of navigation element as a String

Throws:

RemoteEclipseAPIException

getApplication

java.lang.String getApplication()
                                throws RemoteEclipseAPIException

Returns the unique ID of the application that this navigation element is associated with.

Returns:

The unique ID for the application

Throws:

RemoteEclipseAPIException

contributeToLauncher

boolean contributeToLauncher()
                             throws RemoteEclipseAPIException

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

com.ibm.rcp.launcher = true | false If this value is true then this perspective should be contributed to the launcher.

Returns:

true of false to determine if the element is added to the launcher.

Throws:

RemoteEclipseAPIException

isHidden

boolean isHidden()
                 throws RemoteEclipseAPIException

This method returns a boolean indicating whether or not this navigation element is visible to end users and is renderable in the UI. Hidden pages may contain data model related info that is not rendered within the client.

Returns:

True if the element is hidden, false otherwise

Throws:

RemoteEclipseAPIException

getPreference

java.lang.String[] getPreference(java.lang.String key)
                                 throws RemoteEclipseAPIException

Returns an arbitrary preference set within the context of this Navigation object. This is a convenience method to allow for retrieval of custom attributes that may be added to a navigation element. This method may return an empty array if the attribute is not found. The array returned will always be strings and may contain a single element.

Parameters:

key - The name of the attribute

Returns:

The value of the attribute.

Throws:

RemoteEclipseAPIException

getImage

java.lang.String getImage()
                          throws RemoteEclipseAPIException

This method returns the image file path for the page or label to be used within the user interface layer. This is the image the user sees when using the UI navigator to select pages.

Returns:

The path of the image file to be rendered in the navigator

Throws:

RemoteEclipseAPIException

getPreferenceKeys

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

Returns an array of all attribute keys for this navigation element. A key can be passed to getPreference(String key) to retrieve an attribute.

Returns:

array of keys

Throws:

RemoteEclipseAPIException

copy

IRemoteNavigation copy(boolean recursive)
                       throws RemoteEclipseAPIException

Creates a copy of the navigation element

Parameters:

recursive - true for recursive copy

Returns:

copy of navigation element

Throws:

RemoteEclipseAPIException

add

void add(IRemoteNavigation child)
         throws RemoteEclipseAPIException

Adds a child Navigation object to this Navigation object.

Parameters:

child - The child object to be added

Throws:

RemoteEclipseAPIException

remove

void remove(IRemoteNavigation child)
            throws RemoteEclipseAPIException

Removes a child Navigation object from this Navigation object.

Parameters:

child - The child object to be removed

Throws:

RemoteEclipseAPIException