EGF Engine
Release 0.1.0

org.eclipse.egf.pattern.ui.internal.editor.page.implementation
Class MethodPatternCodeViewer

java.lang.Object
  extended by org.eclipse.egf.common.ui.viewers.AbstractViewerWithButtons
      extended by org.eclipse.egf.common.ui.viewers.OrderedListViewer
          extended by org.eclipse.egf.common.ui.viewers.OrderedListViewerWithAddAndRemove
              extended by org.eclipse.egf.pattern.ui.internal.editor.page.implementation.MethodPatternCodeViewer

public class MethodPatternCodeViewer
extends OrderedListViewerWithAddAndRemove

Method pattern code viewer.
Suitable for modifying the pattern code of a pattern method, whether this method is public (generate) or an internal one (any other one).


Nested Class Summary
protected  class MethodPatternCodeViewer.MethodPatternCodeContentHandler
          Method pattern code content handler.
protected  class MethodPatternCodeViewer.MethodPatternCodeContentProvider
          Method pattern code content provider.
 
Nested classes/interfaces inherited from class org.eclipse.egf.common.ui.viewers.AbstractViewerWithButtons
AbstractViewerWithButtons.ButtonData
 
Field Summary
protected  MethodPatternCodeViewer.MethodPatternCodeContentHandler _contentHandler
          Content handler.
protected  AbstractPatternPage _page
          Containing page.
 
Fields inherited from class org.eclipse.egf.common.ui.viewers.AbstractViewerWithButtons
_buttonData, _decoratedViewer
 
Constructor Summary
MethodPatternCodeViewer(AbstractPatternPage patternPage_p, Composite parent_p)
          Constructor.
 
Method Summary
protected  org.eclipse.egf.common.ui.toolkit.widgets.handler.SelectionChangedHandler createRemoveButtonHandler()
          Create remove button handler.
protected  StructuredViewer createViewer(Composite composite_p)
          Default viewer is TableViewer with one column (to support labels and icons).
protected  IContentHandler getContentHandler()
          Get content handler instance.
protected  AbstractPatternPage getPage()
          Get containing page, if any.
 void initialize(List<String> availableActions_p, boolean allowNextAndBack_p, boolean recomputeOnChanges_p)
          Initialize viewer.
 void savePatternCode()
          Save pattern code for handled method.
 void setInput(EOperation method_p)
          Set viewer input to given not null one.
 void setSelection(ISelection selection_p)
          Set selection for this viewer.
 void widgetDisposed(DisposeEvent e_p)
           
 
Methods inherited from class org.eclipse.egf.common.ui.viewers.OrderedListViewerWithAddAndRemove
createAddButtonHandler, createExtraButtonData, delegateButtonClicked
 
Methods inherited from class org.eclipse.egf.common.ui.viewers.OrderedListViewer
createButtonData, getElementCount, getSelectionIndex, getUnderlyingViewerControl
 
Methods inherited from class org.eclipse.egf.common.ui.viewers.AbstractViewerWithButtons
buttonSelected, createButton, createEmptySpace, getDecoratedViewer, init, isEditable, setButtonClickedListener, updateButtons
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_page

protected AbstractPatternPage _page
Containing page.


_contentHandler

protected MethodPatternCodeViewer.MethodPatternCodeContentHandler _contentHandler
Content handler.

Constructor Detail

MethodPatternCodeViewer

public MethodPatternCodeViewer(AbstractPatternPage patternPage_p,
                               Composite parent_p)
Constructor.

Parameters:
page_p -
parent_p -
Method Detail

getPage

protected AbstractPatternPage getPage()
Get containing page, if any.

Returns:
Containing page, or null if none.

createViewer

protected StructuredViewer createViewer(Composite composite_p)
Description copied from class: OrderedListViewer
Default viewer is TableViewer with one column (to support labels and icons).

Overrides:
createViewer in class OrderedListViewer
See Also:
org.eclipse.egf.common.ui.viewers.AbstractViewerWithButtons#createViewer(org.eclipse.swt.widgets.Composite)

createRemoveButtonHandler

protected org.eclipse.egf.common.ui.toolkit.widgets.handler.SelectionChangedHandler createRemoveButtonHandler()
Description copied from class: OrderedListViewerWithAddAndRemove
Create remove button handler.
This implementation returns null.

Overrides:
createRemoveButtonHandler in class OrderedListViewerWithAddAndRemove
Returns:
null
See Also:
OrderedListViewerWithAddAndRemove.createRemoveButtonHandler()

initialize

public void initialize(List<String> availableActions_p,
                       boolean allowNextAndBack_p,
                       boolean recomputeOnChanges_p)
Initialize viewer.

Parameters:
availableActions_p - list of actions that can be created (and thus are available) by the user.
allowNextAndBack_p - should user be able to modify both the action type and its parameter ? true if so, false otherwise. In this case, the user is only capable of choosing the action type.
recomputeOnChanges_p - should method pattern code annotations be recomputed each time a change occurs ? true if so, false if it is saved later using the savePatternCode() method.

widgetDisposed

public void widgetDisposed(DisposeEvent e_p)
See Also:
org.eclipse.swt.events.DisposeListener#widgetDisposed(org.eclipse.swt.events.DisposeEvent)

setInput

public void setInput(EOperation method_p)
Set viewer input to given not null one.

Parameters:
input_p -

setSelection

public void setSelection(ISelection selection_p)
Set selection for this viewer.

Parameters:
empty_p -

savePatternCode

public void savePatternCode()
Save pattern code for handled method.


getContentHandler

protected IContentHandler getContentHandler()
Description copied from class: OrderedListViewerWithAddAndRemove
Get content handler instance.
Implementor is advised to return the same reference each time this method is called.

Specified by:
getContentHandler in class OrderedListViewerWithAddAndRemove
Returns:
A not null instance of IContentHandler.
See Also:
OrderedListViewerWithAddAndRemove.getContentHandler()

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.