Package de.uni_hildesheim.sse.ui.embed

Class EditorUtils

java.lang.Object

de.uni_hildesheim.sse.ui.embed.EditorUtils

All Implemented Interfaces:

EditorEmbedderFactory.IEditorCreator, ModelEditorConfigurer.IModelEditorConfigurer

public class EditorUtils
extends java.lang.Object
implements EditorEmbedderFactory.IEditorCreator, ModelEditorConfigurer.IModelEditorConfigurer

Provides editor utility methods.

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	EXTENSION

Constructor Summary

Constructors

Constructor	Description
EditorUtils()	Creates an instance (public constructor required by OSGI-DS).

Method Summary

Modifier and Type	Method	Description
protected void	activate(org.osgi.service.component.ComponentContext context)	Private method to activate plugin.
ModelEditorConfigurer.IHeader	createHeader(org.eclipse.swt.widgets.Composite parent, Configuration config, java.io.File base, ModelInfo<?> info)	Creates the actual header.
protected void	deactivate(org.osgi.service.component.ComponentContext context)	Private method to to de-activate plugin.
IEmbeddedEditor	embedEditor(java.net.URI resourceURI, org.eclipse.swt.widgets.Composite composite)	Embeds an editor handling the given resourceURI.
static IEmbeddedEditor	embedVilEditor(java.net.URI file, org.eclipse.swt.widgets.Composite parent)	Embeds an VIL editor for the given resource into the given parent.
java.lang.String	getEditorTitle(boolean editable)	Returns the editor title.
java.lang.String	getExtension()	Returns the file extension to configure fore.
AbstractModelChangeListener	getModelChangeListener()	Returns the model change listener, e.g., to rebuild the related model on save.
int	getOrdinal()	Returns an ordinal for sorting model configurers for displying them.
java.lang.String	getPageTitle(boolean editable)	Returns the page title.
boolean	hasHeader()	Returns whether the described editor shall have a header.

Methods inherited from class java.lang.Object

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

Field Detail

EXTENSION

public static final java.lang.String EXTENSION

Constructor Detail

EditorUtils

public EditorUtils()

Creates an instance (public constructor required by OSGI-DS).

Method Detail

embedVilEditor

public static IEmbeddedEditor embedVilEditor(java.net.URI file,
                                             org.eclipse.swt.widgets.Composite parent)

Embeds an VIL editor for the given resource into the given parent.

Parameters:

file - the file representing the resource

parent - the parent UI component

Returns:

the embedded editor (or null if embedding failed)

activate

protected void activate(org.osgi.service.component.ComponentContext context)

Private method to activate plugin.

Parameters:

context - Context.

deactivate

protected void deactivate(org.osgi.service.component.ComponentContext context)

Private method to to de-activate plugin.

Parameters:

context - Context.

embedEditor

public IEmbeddedEditor embedEditor(java.net.URI resourceURI,
                                   org.eclipse.swt.widgets.Composite composite)

Description copied from interface: EditorEmbedderFactory.IEditorCreator

Embeds an editor handling the given resourceURI.

Specified by:

embedEditor in interface EditorEmbedderFactory.IEditorCreator

Parameters:

resourceURI - the URI to be handled

composite - the parent composite to embed the editor into

Returns:

the embedded editor (or null if embedding failed for some reason)

getEditorTitle

public java.lang.String getEditorTitle(boolean editable)

Description copied from interface: ModelEditorConfigurer.IModelEditorConfigurer

Returns the editor title.

Specified by:

getEditorTitle in interface ModelEditorConfigurer.IModelEditorConfigurer

Parameters:

editable - whether the editor is editable

Returns:

the editor title

getPageTitle

public java.lang.String getPageTitle(boolean editable)

Description copied from interface: ModelEditorConfigurer.IModelEditorConfigurer

Returns the page title.

Specified by:

getPageTitle in interface ModelEditorConfigurer.IModelEditorConfigurer

Parameters:

editable - whether the editor is editable

Returns:

the page title

getExtension

public java.lang.String getExtension()

Description copied from interface: ModelEditorConfigurer.IModelEditorConfigurer

Returns the file extension to configure fore.

Specified by:

getExtension in interface ModelEditorConfigurer.IModelEditorConfigurer

Returns:

the file extension

getOrdinal

public int getOrdinal()

Description copied from interface: ModelEditorConfigurer.IModelEditorConfigurer

Returns an ordinal for sorting model configurers for displying them.

Specified by:

getOrdinal in interface ModelEditorConfigurer.IModelEditorConfigurer

Returns:

the ordinal

hasHeader

public boolean hasHeader()

Description copied from interface: ModelEditorConfigurer.IModelEditorConfigurer

Returns whether the described editor shall have a header.

Specified by:

hasHeader in interface ModelEditorConfigurer.IModelEditorConfigurer

Returns:

true if it shall have a header, false else

createHeader

public ModelEditorConfigurer.IHeader createHeader(org.eclipse.swt.widgets.Composite parent,
                                                  Configuration config,
                                                  java.io.File base,
                                                  ModelInfo<?> info)

Description copied from interface: ModelEditorConfigurer.IModelEditorConfigurer

Creates the actual header.

Specified by:

createHeader in interface ModelEditorConfigurer.IModelEditorConfigurer

Parameters:

parent - the parent composite

config - the recent product line configuration

base - the basic directory of the project we are working in

info - the actual model being displayed

Returns:

the header instance

getModelChangeListener

public AbstractModelChangeListener getModelChangeListener()

Description copied from interface: ModelEditorConfigurer.IModelEditorConfigurer

Returns the model change listener, e.g., to rebuild the related model on save.

Specified by:

getModelChangeListener in interface ModelEditorConfigurer.IModelEditorConfigurer

Returns:

the model change listener or null for none