Humboldt Alignment Editor 2.5.0

eu.esdihumboldt.hale.ui.function.generic.pages
Class EntitiesPage<T extends AbstractFunction<D>,D extends AbstractParameter,F extends Field<D,?>>

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<D,T>>
              extended by eu.esdihumboldt.hale.ui.function.generic.pages.EntitiesPage<T,D,F>
Type Parameters:
T - the function type
F - the field type
D - the field definition
All Implemented Interfaces:
FunctionWizardPage, org.eclipse.jface.dialogs.IDialogPage, org.eclipse.jface.dialogs.IMessageProvider, org.eclipse.jface.wizard.IWizardPage
Direct Known Subclasses:
PropertyEntitiesPage, TypeEntitiesPage

public abstract class EntitiesPage<T extends AbstractFunction<D>,D extends AbstractParameter,F extends Field<D,?>>
extends HaleWizardPage<AbstractGenericFunctionWizard<D,T>>
implements FunctionWizardPage

Page that allows assigning cell entities

Author:
Simon Templer

Field Summary
 
Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider
ERROR, INFORMATION, NONE, WARNING
 
Constructor Summary
EntitiesPage(SchemaSelection initialSelection, Cell initialCell)
          Create the entities page
 
Method Summary
 void configureCell(MutableCell cell)
          Configure the given cell
protected  void createContent(org.eclipse.swt.widgets.Composite page)
          Create the page content
protected  org.eclipse.swt.widgets.Control createEntityGroup(SchemaSpaceID ssid, org.eclipse.swt.widgets.Composite parent)
          Create an entity group
protected abstract  F createField(D field, SchemaSpaceID ssid, org.eclipse.swt.widgets.Composite parent, Set<EntityDefinition> candidates, Cell initialCell)
          Create entity assignment fields for the given field definition
protected  org.eclipse.swt.widgets.Control createHeader(org.eclipse.swt.widgets.Composite parent)
          Create the header control.
protected  Set<EntityDefinition> getCandidates(SchemaSpaceID ssid)
          Get the entity candidates for the given schema space
protected  Set<F> getFunctionFields()
          Get the function fields associated with the page
protected  Cell getInitialCell()
           
protected  SchemaSelection getInitialSelection()
           
protected  void onShowPage(boolean firstShow)
          Called when this page is shown
 
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

EntitiesPage

public EntitiesPage(SchemaSelection initialSelection,
                    Cell initialCell)
Create the entities page

Parameters:
initialSelection - the initial schema selection, may be null
initialCell - the initial cell, may be null
Method Detail

createContent

protected void createContent(org.eclipse.swt.widgets.Composite page)
Description copied from class: HaleWizardPage
Create the page content

Specified by:
createContent in class HaleWizardPage<AbstractGenericFunctionWizard<D extends AbstractParameter,T extends AbstractFunction<D>>>
Parameters:
page - the page composite, implementors may assign a custom layout to this composite
See Also:
HaleWizardPage.createContent(Composite)

onShowPage

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

Overrides:
onShowPage in class HaleWizardPage<AbstractGenericFunctionWizard<D extends AbstractParameter,T extends AbstractFunction<D>>>
Parameters:
firstShow - specifies if it is the first time the page is shown since its creation
See Also:
HaleWizardPage.onShowPage(boolean)

getInitialCell

protected Cell getInitialCell()
Returns:
the initial cell

getInitialSelection

protected SchemaSelection getInitialSelection()
Returns:
the initial selection

getFunctionFields

protected Set<F> getFunctionFields()
Get the function fields associated with the page

Returns:
the function fields

createHeader

protected org.eclipse.swt.widgets.Control createHeader(org.eclipse.swt.widgets.Composite parent)
Create the header control.

Parameters:
parent - the parent composite
Returns:
the header control or null

getCandidates

protected Set<EntityDefinition> getCandidates(SchemaSpaceID ssid)
Get the entity candidates for the given schema space

Parameters:
ssid - the schema space ID
Returns:
the entity candidates

createEntityGroup

protected org.eclipse.swt.widgets.Control createEntityGroup(SchemaSpaceID ssid,
                                                            org.eclipse.swt.widgets.Composite parent)
Create an entity group

Parameters:
ssid - the schema space id
parent - the parent composite
Returns:
the main group control

createField

protected abstract F createField(D field,
                                 SchemaSpaceID ssid,
                                 org.eclipse.swt.widgets.Composite parent,
                                 Set<EntityDefinition> candidates,
                                 Cell initialCell)
Create entity assignment fields for the given field definition

Parameters:
ssid - the schema space identifier
field - the field definition, may be a PropertyParameter or a TypeParameter
parent - the parent composite
candidates - the entity candidates
initialCell - the initial cell
Returns:
the created field or null

configureCell

public void configureCell(MutableCell cell)
Description copied from interface: FunctionWizardPage
Configure the given cell

Specified by:
configureCell in interface FunctionWizardPage
Parameters:
cell - the cell
See Also:
FunctionWizardPage.configureCell(MutableCell)

Humboldt Alignment Editor 2.5.0

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