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

All Superinterfaces:

IRemoteEclipseWrapper

public interface IRemoteComponentData
extends IRemoteEclipseWrapper

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

Original documentation:
Interface to individual component elements which are contained within a page. Individual attributes or meta data associated with the component can be retrieved via this interface. This interface is not intended to be implemented by clients.

Method Summary

java.lang.String	getFolder() If this component is an SWT view and should be placed within a folder in a perspective layout, this method will return the identifier of that folder.
java.lang.String	getId() Returns the entity identifier for this component.
java.lang.String[]	getPreference(java.lang.String key) Returns a preference value for the given key.
java.lang.String[]	getPreferenceKeys() This method simply returns the entire list of data element attributes contained by this ComponentData object.
float	getRatio() Returns the ratio value for this view within the layout.
java.lang.String	getViewId() Returns the view id which maps to this component.
boolean	isCloseable() Returns a boolean determining if this view should be closeable in the perspective.
boolean	isFastView() Returns a boolean determining if this view should be added to the IPageLayout as a fast view.
boolean	isMoveable() Returns a boolean determining if this view should be moveable within the perspective.
boolean	isStandalone() Returns a boolean determining if this view should be added to the IPageLayout as a standalone view.
boolean	isVisible() Returns a boolean determining if this view should be made visible when it is initially added to a perspective layout.
boolean	showTitle() Returns a boolean determining if this view should have a title.

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

_internalGetId, equalWrappedObjects

Method Detail

getPreferenceKeys

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

This method simply returns the entire list of data element attributes contained by this ComponentData object.

If no attributes exist for this component this method will return an empty array.

Returns:

Array of strings cotaining the attribute names.

Throws:

RemoteEclipseAPIException

getPreference

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

Returns a preference value for the given key. This method is also implicitly called by the other methods exposed in this interface with a known key.

Preferences can have multiple values. Consumers of this method wishing only to retrieve a single value should check the size of the array first before retrieving the value desired.

This method is provided as a means to retrieve arbitrary preference values which the Topology Handler has no way of knowing about.

Parameters:

key - The key to the value to be retrieved.

Returns:

String array value for the given key.

Throws:

RemoteEclipseAPIException

getId

java.lang.String getId()
                       throws RemoteEclipseAPIException

Returns the entity identifier for this component. The entity identifier is the identifier used to construct the secondary id for the component view.

In portal based environments this id is the portlet entity instance id.

Returns:

The unique identifier of this component.

Throws:

RemoteEclipseAPIException

getViewId

java.lang.String getViewId()
                           throws RemoteEclipseAPIException

Returns the view id which maps to this component. The component mapping to this object represents an Eclipse SWT view which will use the data contained in this ComponentData object.

This method may return null if no view id is associated with the component.

Returns:

The SWT based view id associated with the component.

Throws:

RemoteEclipseAPIException

getFolder

java.lang.String getFolder()
                           throws RemoteEclipseAPIException

If this component is an SWT view and should be placed within a folder in a perspective layout, this method will return the identifier of that folder.

Returns:

Folder id for which this component should be placed.

Throws:

RemoteEclipseAPIException

isCloseable

boolean isCloseable()
                    throws RemoteEclipseAPIException

Returns a boolean determining if this view should be closeable in the perspective.
Maps to preference com.ibm.rcp.closeable

Returns:

True if this view is closeable, false otherwise.

Throws:

RemoteEclipseAPIException

isMoveable

boolean isMoveable()
                   throws RemoteEclipseAPIException

Returns a boolean determining if this view should be moveable within the perspective.

Maps to preference com.ibm.rcp.moveable

Returns:

True if this view is moveable, false otherwise.

Throws:

RemoteEclipseAPIException

isVisible

boolean isVisible()
                  throws RemoteEclipseAPIException

Returns a boolean determining if this view should be made visible when it is initially added to a perspective layout. This is only applicable for components which are SWT based views.

Hidden views are added to an IPageLayout object as placeholders and become visible only when they are programmatically opened.

The default value returned from this method is false.

Returns:

True if the view is visible, false otherwise.

Throws:

RemoteEclipseAPIException

getRatio

float getRatio()
               throws RemoteEclipseAPIException

Returns the ratio value for this view within the layout. Ratios determine the amount of space a view should take up in relation to its relative ViewPart. The relative part for a view is the part to which this view is attached when it is added to the IPageLayout.

For example, if View A is added to the layout relative to View B. View A has a ratio value of .25. This means that View A will take 75% of the space and 25% will be taken by View B.

The default value returned from this method is a default value of 0.5f.

Returns:

Throws:

RemoteEclipseAPIException

isFastView

boolean isFastView()
                   throws RemoteEclipseAPIException

Returns a boolean determining if this view should be added to the IPageLayout as a fast view.

Fast views are added to the fast view bar in the client. a fast view ratio should be specified as data as well. Although there is no convenience API to retrieve the fast view ratio from this object, a consumer can use the getPreference(String...) method to retrieve a value representing the fast view ratio.

The fast view ratio determines the amount of screen the component should take up. The default value returned by this method is false.

Returns:

True if this view is a fast view, false otherwise.

Throws:

RemoteEclipseAPIException

isStandalone

boolean isStandalone()
                     throws RemoteEclipseAPIException

Returns a boolean determining if this view should be added to the IPageLayout as a standalone view. Standalone views can be added with or without a title.

Returns:

True if this view is a fast view, false otherwise.

Throws:

RemoteEclipseAPIException

showTitle

boolean showTitle()
                  throws RemoteEclipseAPIException

Returns a boolean determining if this view should have a title. The preference for this value is determined by com.ibm.rcp.showTitle. A view with no title will be added to the IPageLayout as a standalone view.

Returns:

True if this view should be added with no title, false otherwise.

Throws:

RemoteEclipseAPIException