EGF Engine
Release 0.1.0

org.eclipse.egf.pattern.ui.editor.page
Class AbstractPatternPage

java.lang.Object
  extended by FormPage
      extended by org.eclipse.egf.pattern.ui.editor.page.AbstractPatternPage
All Implemented Interfaces:
IExternalSelectionHandler
Direct Known Subclasses:
PatternConnectionPage, PatternContextPage, PatternImplementationPage, PatternInheritancePage, PatternOverviewPage, PatternProductionPage, PatternSpecificationPage

public abstract class AbstractPatternPage
extends FormPage
implements IExternalSelectionHandler

Abstract pattern page.
Handles access to pattern data.


Nested Class Summary
protected  class AbstractPatternPage.TextValidator
          Textual control validation class.
 
Constructor Summary
AbstractPatternPage(FormEditor editor_p, String id_p, String title_p)
          Constructor.
 
Method Summary
protected  void clearErrors(Control control_p)
          Clear all errors for given control.
protected  void createFormContent(IManagedForm managedForm_p)
           
protected abstract  AbstractPatternBlock createPatternBlock()
          Get a new pattern block implementation, if this page has to use the master/details approach.
protected  void dataSaved()
          Data have been saved.
protected  void doCreateFormContent(FormToolkit toolkit_p, Composite parent_p, PatternHandler.PatternData patternData_p, IManagedForm managedForm_p)
          Do create form content.
 void editorAboutToBeSaved()
          Editor is about to be saved.
 void editorSaved()
          Editor saved notification.
 PatternEditor getEditor()
           
protected  ExternalSelectionManager getExternalSelectionManager()
          Get external selection manager.
abstract  String getHelpContextId()
          Get help context id for current page.
 PatternHandler.PatternData getPatternData()
          Get available pattern data.
protected  PatternHandler getPatternHandler()
          Get pattern handler.
 void handleSelection(Object firstSelectedObject_p, IStructuredSelection selection_p)
          Handle selection.
 boolean hasErrors()
          Has current page some errors ?
 boolean isDirty()
           
 boolean isEditable()
          Is page editable ?
protected  void reportError(Control control_p, String errorText_p, String errorKey_p)
          Report an error for given control.
 void setDirty(boolean isDirty_p)
          Set page dirty state.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractPatternPage

public AbstractPatternPage(FormEditor editor_p,
                           String id_p,
                           String title_p)
Constructor.

Parameters:
editor_p -
id_p -
title_p -
Method Detail

handleSelection

public void handleSelection(Object firstSelectedObject_p,
                            IStructuredSelection selection_p)
Description copied from interface: IExternalSelectionHandler
Handle selection.

Specified by:
handleSelection in interface IExternalSelectionHandler
Parameters:
firstSelectedObject_p - The first object selected in given structured selection.
selection_p - The whole selection.
See Also:
org.eclipse.egf.pattern.ui.editor.page.IExternalSelectionHandler#handleSelection(java.lang.Object, org.eclipse.jface.viewers.IStructuredSelection)

getHelpContextId

public abstract String getHelpContextId()
Get help context id for current page.
Must be prefixed by the page plug-in id.

Returns:

editorAboutToBeSaved

public void editorAboutToBeSaved()
Editor is about to be saved.
Data are still valid.
The page is giving an opportunity to save its state, or its data.


editorSaved

public final void editorSaved()
Editor saved notification.


setDirty

public void setDirty(boolean isDirty_p)
Set page dirty state.


isDirty

public boolean isDirty()
See Also:
org.eclipse.ui.forms.editor.FormPage#isDirty()

isEditable

public boolean isEditable()
Is page editable ?

Returns:

dataSaved

protected void dataSaved()
Data have been saved.
Change page internal state accordingly.


getPatternData

public PatternHandler.PatternData getPatternData()
Get available pattern data.
Null if it could not be found for containing editor.

Returns:

getPatternHandler

protected PatternHandler getPatternHandler()
Get pattern handler.

Returns:

getExternalSelectionManager

protected ExternalSelectionManager getExternalSelectionManager()
Get external selection manager.

Returns:

hasErrors

public boolean hasErrors()
Has current page some errors ?

Returns:

reportError

protected void reportError(Control control_p,
                           String errorText_p,
                           String errorKey_p)
Report an error for given control.

Parameters:
control_p -
errorText_p -

clearErrors

protected void clearErrors(Control control_p)
Clear all errors for given control.

Parameters:
control_p -

getEditor

public PatternEditor getEditor()
See Also:
org.eclipse.ui.forms.editor.FormPage#getEditor()

createFormContent

protected void createFormContent(IManagedForm managedForm_p)
See Also:
org.eclipse.ui.forms.editor.FormPage#createFormContent(org.eclipse.ui.forms.IManagedForm)

createPatternBlock

protected abstract AbstractPatternBlock createPatternBlock()
Get a new pattern block implementation, if this page has to use the master/details approach.
Returning null here implies overriding the #doCreateFormContent(FormToolkit, Composite, PatternData, IManagedForm) method entirely.

Returns:

doCreateFormContent

protected void doCreateFormContent(FormToolkit toolkit_p,
                                   Composite parent_p,
                                   PatternHandler.PatternData patternData_p,
                                   IManagedForm managedForm_p)
Do create form content.
Should be overridden by page that were not created using a pattern block.

Parameters:
toolkit_p - Managed form toolkit.
parent_p - Managed form composite.
patternData_p - Pattern data for current pattern edition.
managedForm_p -

EGF Engine
Release 0.1.0

Copyright (c) Thales Corporate Services S.A.S, 2009.

This page is made available under license. For full details see the LEGAL in the documentation book that contains this page.