Eclipse GMF Guide (Galileo) - GetTypesOperation (Eclipse GMF Documentation)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Runtime

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.gmf.runtime.emf.ui.services.modelingassistant
Class GetTypesOperation

java.lang.Object
  
org.eclipse.gmf.runtime.emf.ui.services.modelingassistant.GetTypesOperation

All Implemented Interfaces:: IOperation, IModelingAssistantOperation

public class GetTypesOperation
extends java.lang.Object
implements IModelingAssistantOperation
extends java.lang.Object
implements IModelingAssistantOperation

The operation used with the modeling assistant service that gets the type of elements that can be created or used for a specific hint or gesture and optional data.

Field Summary

Fields inherited from interface org.eclipse.gmf.runtime.emf.ui.services.modelingassistant. IModelingAssistantOperation

GET_REL_TYPES_FOR_SRE_ON_SOURCE_ID, GET_REL_TYPES_FOR_SRE_ON_TARGET_ID, GET_REL_TYPES_ON_SOURCE_AND_TARGET_ID, GET_REL_TYPES_ON_SOURCE_ID, GET_REL_TYPES_ON_TARGET_ID, GET_TYPES_FOR_POPUP_BAR_ID, GET_TYPES_FOR_SOURCE_ID, GET_TYPES_FOR_TARGET_ID, GET_TYPES_ID, SELECT_EXISTING_ELEMENT_FOR_SOURCE_ID, SELECT_EXISTING_ELEMENT_FOR_TARGET_ID

Constructor Summary

protected GetTypesOperation (java.lang.String hint, IAdaptable data)
          Creates a new GetTypesOperation.

Method Summary

java.lang.Object execute ( IProvider provider)
          Executes this operation on the specified provider.

IAdaptable getContext ()
          Returns the context object to match that specified in the plugin.xml for deferred loading.

IAdaptable getData ()
          Gets the additional data required (if applicable).

java.lang.String getHint ()
          Gets the hint that identifies the gesture.

java.lang.String getId ()
          The ID for a this operation is the hint itself.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GetTypesOperation

protected GetTypesOperation(java.lang.String hint,
                            
IAdaptable data)

Creates a new GetTypesOperation.

Parameters:: hint - identifies the hint or gesture; data -
provides additional data that is required

may be null depending on the hint

Method Detail

getId

public java.lang.String getId()

The ID for a this operation is the hint itself.

Specified by:: getId in interface IModelingAssistantOperation

Returns:: the id string

getContext

public 
IAdaptable getContext()

Description copied from interface: IModelingAssistantOperation

Returns the context object to match that specified in the plugin.xml for deferred loading.

Specified by:: getContext in interface IModelingAssistantOperation

Returns:: the context object

execute

public java.lang.Object execute(
IProvider provider)

Description copied from interface: IOperation

Executes this operation on the specified provider.

Service implementers generally implement this method by first casting the provider to their service specific IProvider-derived class and then by delegating it the execution. Delegation is accomplished through the service specific provider derived class API.

Specified by:: execute in interface IOperation

Parameters:: provider - The provider on which to execute the operation.
Returns:: The result of executing this operation.

getHint

public java.lang.String getHint()

Gets the hint that identifies the gesture.

Returns:: the hint

getData

public 
IAdaptable getData()

Gets the additional data required (if applicable).

Returns:: the data, may be null.