Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.ui.function.generic.pages
Class AbstractParameterPage

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.function.generic.pages.AbstractParameterPage
All Implemented Interfaces:
ParameterPage, org.eclipse.jface.dialogs.IDialogPage, org.eclipse.jface.dialogs.IMessageProvider, org.eclipse.jface.wizard.IWizardPage
Direct Known Subclasses:
SequentialIDParameterPage

public abstract class AbstractParameterPage
extends HaleWizardPage<AbstractGenericFunctionWizard<?,?>>
implements ParameterPage

Base class for parameter pages.

Author:
Simon Templer

Field Summary
 
Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider
ERROR, INFORMATION, NONE, WARNING
 
Constructor Summary
AbstractParameterPage(Function function, String description)
          Create a parameter page for the given function.
AbstractParameterPage(String pageName)
           
AbstractParameterPage(String pageName, String title, org.eclipse.jface.resource.ImageDescriptor titleImage)
           
 
Method Summary
protected  com.google.common.collect.ListMultimap<String,String> getInitialValues()
          Get the map of initial values for parameters.
protected  String getOptionalInitialValue(String parameterName, String def)
          Get a single initial value for the given parameter.
protected  com.google.common.collect.ImmutableMap<String,FunctionParameter> getParametersToHandle()
          Get the parameters to handle by this parameter page.
 void setParameter(Set<FunctionParameter> params, com.google.common.collect.ListMultimap<String,String> initialValues)
          Sets the parameters this page is responsible for and their initial values.
 
Methods inherited from class eu.esdihumboldt.hale.ui.HaleWizardPage
createContent, createControl, dispose, getWizard, onShowPage
 
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 eu.esdihumboldt.hale.ui.function.generic.pages.ParameterPage
getConfiguration
 
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

AbstractParameterPage

public AbstractParameterPage(String pageName)
See Also:
HaleWizardPage.HaleWizardPage(String)

AbstractParameterPage

public AbstractParameterPage(String pageName,
                             String title,
                             org.eclipse.jface.resource.ImageDescriptor titleImage)
See Also:
HaleWizardPage.HaleWizardPage(String, String, ImageDescriptor)

AbstractParameterPage

public AbstractParameterPage(Function function,
                             String description)
Create a parameter page for the given function.

Parameters:
function - the function
description - the page description, if null the function description will be used
Method Detail

setParameter

public void setParameter(Set<FunctionParameter> params,
                         com.google.common.collect.ListMultimap<String,String> initialValues)
Description copied from interface: ParameterPage
Sets the parameters this page is responsible for and their initial values. This method is called before creating the page content.
It should only handle the parameters in the given set, even if it could handle more.

Specified by:
setParameter in interface ParameterPage
Parameters:
params - the parameters this page is responsible for
initialValues - initial values of those parameters, may be null, should not be changed
See Also:
ParameterPage.setParameter(Set, ListMultimap)

getInitialValues

protected com.google.common.collect.ListMultimap<String,String> getInitialValues()
Get the map of initial values for parameters.

Returns:
parameter names mapped to their initial values (unmodifiable)

getParametersToHandle

protected com.google.common.collect.ImmutableMap<String,FunctionParameter> getParametersToHandle()
Get the parameters to handle by this parameter page.

Returns:
the set of function parameters to handle (unmodifiable)

getOptionalInitialValue

protected String getOptionalInitialValue(String parameterName,
                                         String def)
Get a single initial value for the given parameter.

Parameters:
parameterName - the parameter name
def - the default value to return if the value is not present
Returns:
the first parameter value or the provided default value

Humboldt Alignment Editor 2.5.0

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