IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.rcp.navigator.core
Interface INavigatable

All Known Subinterfaces:
INavigateFolder, INavigateItem
All Known Implementing Classes:
Navigatable, NavigateFolder, NavigateItem

public interface INavigatable

Navigation item definition interface


Method Summary
 org.eclipse.jface.resource.ImageDescriptor getIcon()
          Get icon of this Navigation Item.
 java.lang.String getId()
          Get id of this navigation item.
 float getIndex()
          Get index of this navigation item
 java.lang.String getName()
          Get the name of this Navigation Item.
 INavigateFolder getParent()
          Get parent navigate folder.
 void initializeFrom(org.eclipse.core.runtime.IConfigurationElement element)
          Initialize navigation item from extension points
 boolean isAvailable()
          Get if this navigatable folder/item is available for the navigator view
 boolean isInitial()
          Get if this navigation item/folder is shown at startup
 void setIcon(org.eclipse.jface.resource.ImageDescriptor icon)
          Set icon of this Navigation Item.
 void setId(java.lang.String id)
          Set id for this navigation item.
 void setIndex(float index)
          Set index of this navigation item
 void setName(java.lang.String name)
          Set the name of this Navigation Item.
 void setParent(INavigateFolder parent)
          Set parent navigate folder.
 

Method Detail

getName

java.lang.String getName()
Get the name of this Navigation Item.

Returns:
name of this Navigation Item

setName

void setName(java.lang.String name)
Set the name of this Navigation Item.

Parameters:
name - name of this Navigation Item

getIcon

org.eclipse.jface.resource.ImageDescriptor getIcon()
Get icon of this Navigation Item.

Returns:
ImageDescriptor for this navigation item icon

setIcon

void setIcon(org.eclipse.jface.resource.ImageDescriptor icon)
Set icon of this Navigation Item.

Parameters:
icon - ImageDescriptor for this navigation item icon

getId

java.lang.String getId()
Get id of this navigation item.

Returns:
navigation item id

setId

void setId(java.lang.String id)
Set id for this navigation item.

Parameters:
id - navigation item id

getIndex

float getIndex()
Get index of this navigation item

Returns:
index of this navigation item

setIndex

void setIndex(float index)
Set index of this navigation item

Parameters:
index - index of this navigation item

initializeFrom

void initializeFrom(org.eclipse.core.runtime.IConfigurationElement element)
Initialize navigation item from extension points

Parameters:
element - extension point definition IConfigurationElement

isAvailable

boolean isAvailable()
Get if this navigatable folder/item is available for the navigator view

Returns:

getParent

INavigateFolder getParent()
Get parent navigate folder. Return null if this is the root element.

Returns:

setParent

void setParent(INavigateFolder parent)
Set parent navigate folder.

Parameters:
parent -

isInitial

boolean isInitial()
Get if this navigation item/folder is shown at startup

Returns:
if this navigation item/folder is shown at startup

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2009