Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.ui.functions.groovy
Class GroovyParameterPage

java.lang.Object
  extended by org.eclipse.jface.dialogs.DialogPage
      extended by org.eclipse.jface.wizard.WizardPage
          extended by eu.esdihumboldt.hale.ui.HaleWizardPage<AbstractGenericFunctionWizard<?,?>>
              extended by eu.esdihumboldt.hale.ui.functions.core.SourceListParameterPage<org.eclipse.jface.text.source.SourceViewer>
                  extended by eu.esdihumboldt.hale.ui.functions.core.SourceViewerParameterPage
                      extended by eu.esdihumboldt.hale.ui.functions.groovy.GroovyParameterPage
All Implemented Interfaces:
GroovyConstants, ParameterPage, org.eclipse.jface.dialogs.IDialogPage, org.eclipse.jface.dialogs.IMessageProvider, org.eclipse.jface.wizard.IWizardPage

public class GroovyParameterPage
extends SourceViewerParameterPage
implements GroovyConstants

Parameter page for Groovy function.

Author:
Kai Schwierczek

Field Summary
 
Fields inherited from interface eu.esdihumboldt.cst.functions.groovy.GroovyConstants
ENTITY_VARIABLE, PARAMETER_SCRIPT
 
Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider
ERROR, INFORMATION, NONE, WARNING
 
Constructor Summary
GroovyParameterPage()
          Default constructor.
 
Method Summary
protected  String getParameterName()
          Should return the parameter which should be configured using all source properties.
protected  String getSourcePropertyName()
          Should return the name of the source property which should be used.
protected  String getVariableName(EntityDefinition variable)
          This gets called for all variables.
Subclasses can change how they are displayed here.
The default format is like "part1.part2.name".
protected  void onShowPage(boolean firstShow)
          Called when this page is shown
protected  void sourcePropertiesChanged(EntityDefinition[] variables)
          This gets called, when the user chose other source properties.
protected  boolean validate(org.eclipse.jface.text.IDocument document)
          Validate the given document.
 
Methods inherited from class eu.esdihumboldt.hale.ui.functions.core.SourceViewerParameterPage
configure, createAndLayoutTextField, createAndSetDocument, createConfiguration, createRuler, getDocument, getText, insertTextAtCurrentPos, setText, updateState
 
Methods inherited from class eu.esdihumboldt.hale.ui.functions.core.SourceListParameterPage
createContent, getConfiguration, getTextField, setParameter
 
Methods inherited from class eu.esdihumboldt.hale.ui.HaleWizardPage
createControl, dispose, getWizard
 
Methods inherited from class org.eclipse.jface.wizard.WizardPage
canFlipToNextPage, getContainer, getDialogSettings, getImage, getName, getNextPage, getPreviousPage, getShell, isCurrentPage, isPageComplete, setDescription, setErrorMessage, setImageDescriptor, setMessage, setPageComplete, setPreviousPage, setTitle, setWizard, toString
 
Methods inherited from class org.eclipse.jface.dialogs.DialogPage
convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, getControl, getDescription, getDialogFontName, getErrorMessage, getFont, getMessage, getMessageType, getTitle, getToolTipText, initializeDialogUnits, isControlCreated, performHelp, setButtonLayoutData, setControl, setMessage, setVisible
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.eclipse.jface.wizard.IWizardPage
canFlipToNextPage, getName, getNextPage, getPreviousPage, getWizard, isPageComplete, setPreviousPage, setWizard
 
Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage
createControl, dispose, getControl, getDescription, getErrorMessage, getImage, getMessage, getTitle, performHelp, setDescription, setImageDescriptor, setTitle, setVisible
 

Constructor Detail

GroovyParameterPage

public GroovyParameterPage()
Default constructor.

Method Detail

onShowPage

protected void onShowPage(boolean firstShow)
Description copied from class: HaleWizardPage
Called when this page is shown

Overrides:
onShowPage in class SourceListParameterPage<org.eclipse.jface.text.source.SourceViewer>
Parameters:
firstShow - specifies if it is the first time the page is shown since its creation
See Also:
SourceListParameterPage.onShowPage(boolean)

getParameterName

protected String getParameterName()
Description copied from class: SourceListParameterPage
Should return the parameter which should be configured using all source properties.

Specified by:
getParameterName in class SourceListParameterPage<org.eclipse.jface.text.source.SourceViewer>
Returns:
the parameter name
See Also:
SourceListParameterPage.getParameterName()

getSourcePropertyName

protected String getSourcePropertyName()
Description copied from class: SourceListParameterPage
Should return the name of the source property which should be used.

Specified by:
getSourcePropertyName in class SourceListParameterPage<org.eclipse.jface.text.source.SourceViewer>
Returns:
the source property name
See Also:
SourceListParameterPage.getSourcePropertyName()

validate

protected boolean validate(org.eclipse.jface.text.IDocument document)
Description copied from class: SourceViewerParameterPage
Validate the given document. The default implementation always returns true.

Overrides:
validate in class SourceViewerParameterPage
Parameters:
document - the document to validate
Returns:
if the document is valid
See Also:
SourceViewerParameterPage.validate(IDocument)

sourcePropertiesChanged

protected void sourcePropertiesChanged(EntityDefinition[] variables)
Description copied from class: SourceListParameterPage
This gets called, when the user chose other source properties.

Overrides:
sourcePropertiesChanged in class SourceListParameterPage<org.eclipse.jface.text.source.SourceViewer>
Parameters:
variables - the new source properties
See Also:
SourceListParameterPage.sourcePropertiesChanged(EntityDefinition[])

getVariableName

protected String getVariableName(EntityDefinition variable)
Description copied from class: SourceListParameterPage
This gets called for all variables.
Subclasses can change how they are displayed here.
The default format is like "part1.part2.name".

Overrides:
getVariableName in class SourceListParameterPage<org.eclipse.jface.text.source.SourceViewer>
Parameters:
variable - the variable
Returns:
the modified name
See Also:
SourceListParameterPage.getVariableName(EntityDefinition)

Humboldt Alignment Editor 2.5.0

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