Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.ui.io.source
Class AbstractSource<P extends ImportProvider>

java.lang.Object
  extended by eu.esdihumboldt.hale.ui.io.source.AbstractSource<P>
Type Parameters:
P - the supported IOProvider type
All Implemented Interfaces:
ImportSource<P>
Direct Known Subclasses:
AbstractProviderSource

public abstract class AbstractSource<P extends ImportProvider>
extends Object
implements ImportSource<P>

Abstract ImportSource implementation

Since:
2.5
Author:
Simon Templer

Nested Class Summary
 
Nested classes/interfaces inherited from interface eu.esdihumboldt.hale.ui.io.ImportSource
ImportSource.SourceConfiguration<P extends ImportProvider>
 
Constructor Summary
AbstractSource()
           
 
Method Summary
 void dispose()
          Dispose any resources when the source page is disposed.
protected  ImportSource.SourceConfiguration<P> getConfiguration()
           
protected  org.eclipse.jface.wizard.WizardPage getPage()
           
 void onActivate()
          Method that is called when the source page is activated.
 void setConfiguration(ImportSource.SourceConfiguration<P> configuration)
          Sets the source configuration to populate.
 void setPage(org.eclipse.jface.wizard.WizardPage page)
          Sets the containing wizard page.
 boolean updateConfiguration(P provider)
          Update the configuration (of the I/O provider).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface eu.esdihumboldt.hale.ui.io.ImportSource
createControls
 

Constructor Detail

AbstractSource

public AbstractSource()
Method Detail

setPage

public void setPage(org.eclipse.jface.wizard.WizardPage page)
Description copied from interface: ImportSource
Sets the containing wizard page. It may be used for displaying messages.

Specified by:
setPage in interface ImportSource<P extends ImportProvider>
Parameters:
page - the wizard page
See Also:
ImportSource.setPage(WizardPage)

setConfiguration

public void setConfiguration(ImportSource.SourceConfiguration<P> configuration)
Description copied from interface: ImportSource
Sets the source configuration to populate.

Specified by:
setConfiguration in interface ImportSource<P extends ImportProvider>
Parameters:
configuration - the source configuration
See Also:
ImportSource.setConfiguration(SourceConfiguration)

getPage

protected org.eclipse.jface.wizard.WizardPage getPage()
Returns:
the wizard page

getConfiguration

protected ImportSource.SourceConfiguration<P> getConfiguration()
Returns:
the wizard

updateConfiguration

public boolean updateConfiguration(P provider)
Update the configuration (of the I/O provider). This is executed right before the execution.

By default doesn't change the provider and returns true.

Specified by:
updateConfiguration in interface ImportSource<P extends ImportProvider>
Parameters:
provider - the I/O provider to update
Returns:
if the source is valid and updating the provider was successful

onActivate

public void onActivate()
Method that is called when the source page is activated.

The default implementation does nothing, override to to react on activation of the source page.

Specified by:
onActivate in interface ImportSource<P extends ImportProvider>

dispose

public void dispose()
Description copied from interface: ImportSource
Dispose any resources when the source page is disposed.

Specified by:
dispose in interface ImportSource<P extends ImportProvider>
See Also:
ImportSource.dispose()

Humboldt Alignment Editor 2.5.0

Build 2012-12-03_12-30-59
Revision 9d2dd4b0318cda9f1393b1ddd390f7f792d70a2d