net.officefloor.eclipse.common.dialog.input.impl

Class ClasspathFileInput

java.lang.Object

net.officefloor.eclipse.common.dialog.input.impl.ClasspathFileInput

All Implemented Interfaces:

Input<org.eclipse.swt.widgets.Composite>

Direct Known Subclasses:

WoofFileInput

public class ClasspathFileInput
extends Object
implements Input<org.eclipse.swt.widgets.Composite>

Input to obtain a file from the class path.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor and Description
ClasspathFileInput(org.eclipse.core.resources.IContainer container, org.eclipse.swt.widgets.Shell shell) Initiate.
ClasspathFileInput(org.eclipse.ui.IEditorPart editor) Convenience constructor to use the IProject and Shell of the IEditorPart.

Method Summary

Modifier and Type	Method and Description
org.eclipse.swt.widgets.Composite	buildControl(InputContext context) Builds the Control.
Object	getValue(org.eclipse.swt.widgets.Composite control, InputContext context) Obtains the value from the input Control.
protected String	transformToPath(org.eclipse.core.resources.IFile file) Transforms the IFile to the path to use.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClasspathFileInput

public ClasspathFileInput(org.eclipse.core.resources.IContainer container,
                          org.eclipse.swt.widgets.Shell shell)

Initiate.

Parameters:

container - IContainer to find the file within.

shell - Shell.

ClasspathFileInput

public ClasspathFileInput(org.eclipse.ui.IEditorPart editor)

Convenience constructor to use the IProject and Shell of the IEditorPart.

Parameters:

editor - IEditorPart.

Method Detail

transformToPath

protected String transformToPath(org.eclipse.core.resources.IFile file)

Transforms the IFile to the path to use.

Allows overriding for more specialised transformation.

Parameters:

file - IFile.

Returns:

path to use.

buildControl

public org.eclipse.swt.widgets.Composite buildControl(InputContext context)

Description copied from interface: Input

Builds the Control.

Specified by:

buildControl in interface Input<org.eclipse.swt.widgets.Composite>

Parameters:

context - InputContext.

Returns:

Control to input the value.

getValue

public Object getValue(org.eclipse.swt.widgets.Composite control,
                       InputContext context)

Description copied from interface: Input

Obtains the value from the input Control.

The input Control will be the one created by Input.buildControl(InputContext).

Specified by:

getValue in interface Input<org.eclipse.swt.widgets.Composite>

Parameters:

control - Control.

context - InputContext.

Returns:

Value.