net.officefloor.eclipse.extension.worksource.clazz
Class DesignWorkSourceExtension

java.lang.Object
  net.officefloor.eclipse.extension.worksource.clazz.DesignWorkSourceExtension

All Implemented Interfaces:

WorkSourceExtension<net.officefloor.frame.api.execute.Work,net.officefloor.plugin.work.design.DesignWorkSource>

public class DesignWorkSourceExtension
extends Object
implements WorkSourceExtension<net.officefloor.frame.api.execute.Work,net.officefloor.plugin.work.design.DesignWorkSource>

WorkSourceExtension for the DesignWorkSource.

Author:

Daniel Sagenschneider

Field Summary

Fields inherited from interface net.officefloor.eclipse.extension.worksource.WorkSourceExtension

EXTENSION_ID

Constructor Summary

DesignWorkSourceExtension()

Method Summary

void	createControl(org.eclipse.swt.widgets.Composite page, WorkSourceExtensionContext context) Loads the input page with the necessary Control instances to populate the PropertyList.
String	getSuggestedWorkName(net.officefloor.compile.properties.PropertyList properties) Obtains the suggested name of the Work.
String	getTaskDocumentation(TaskDocumentationContext context) Obtains documentation about a Task of the Work.
Class<net.officefloor.plugin.work.design.DesignWorkSource>	getWorkSourceClass() Obtains the class of the WorkSource being enriched in its usage.
String	getWorkSourceLabel() Obtains the label for the WorkSource.

Methods inherited from class java.lang.Object

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

Constructor Detail

DesignWorkSourceExtension

public DesignWorkSourceExtension()

Method Detail

getWorkSourceClass

public Class<net.officefloor.plugin.work.design.DesignWorkSource> getWorkSourceClass()

Description copied from interface: WorkSourceExtension

Obtains the class of the WorkSource being enriched in its usage.

Specified by:

getWorkSourceClass in interface WorkSourceExtension<net.officefloor.frame.api.execute.Work,net.officefloor.plugin.work.design.DesignWorkSource>

Returns:

Class of the WorkSource being enriched in its usage.

getWorkSourceLabel

public String getWorkSourceLabel()

Description copied from interface: WorkSourceExtension

Obtains the label for the WorkSource.

This is a descriptive name that can be used other than the fully qualified name of the WorkSource.

Specified by:

getWorkSourceLabel in interface WorkSourceExtension<net.officefloor.frame.api.execute.Work,net.officefloor.plugin.work.design.DesignWorkSource>

Returns:

Label for the WorkSource.

createControl

public void createControl(org.eclipse.swt.widgets.Composite page,
                          WorkSourceExtensionContext context)

Description copied from interface: WorkSourceExtension

Loads the input page with the necessary Control instances to populate the PropertyList. Also allows notifying of changes to Property instances via the WorkSourceExtensionContext.

Specified by:

createControl in interface WorkSourceExtension<net.officefloor.frame.api.execute.Work,net.officefloor.plugin.work.design.DesignWorkSource>

Parameters:

page - Page to be setup for populating the PropertyList.

context - WorkSourceExtensionContext.

getSuggestedWorkName

public String getSuggestedWorkName(net.officefloor.compile.properties.PropertyList properties)

Description copied from interface: WorkSourceExtension

Obtains the suggested name of the Work.

Specified by:

getSuggestedWorkName in interface WorkSourceExtension<net.officefloor.frame.api.execute.Work,net.officefloor.plugin.work.design.DesignWorkSource>

Parameters:

properties - PropertyList.

Returns:

Suggested Work name or null if no suggestion.

getTaskDocumentation

public String getTaskDocumentation(TaskDocumentationContext context)
                            throws Throwable

Description copied from interface: WorkSourceExtension

Obtains documentation about a Task of the Work.

Specified by:

getTaskDocumentation in interface WorkSourceExtension<net.officefloor.frame.api.execute.Work,net.officefloor.plugin.work.design.DesignWorkSource>

Parameters:

context - TaskDocumentationContext.

Returns:

Documentation about the Task.

Throws:

Throwable - If fails to obtain documentation about the Task.