EGF Engine
Release 0.1.0

org.eclipse.egf.pattern.ui.internal.editor.page
Class AbstractPatternPageContentProvider

java.lang.Object
  extended by org.eclipse.egf.common.ui.toolkit.viewers.AbstractStructuredContentProvider
      extended by org.eclipse.egf.pattern.ui.internal.editor.page.AbstractPatternPageContentProvider
Direct Known Subclasses:
MethodPatternCodeViewer.MethodPatternCodeContentProvider, ParameterTypeSelectionPage.ParameterTypeContentProvider, PatternEditorContentOutlinePage.OutlineContentProvider, PatternIdParameterSelectionPage.PatternIdContentProvider, PatternImplementationPage.InternalMethodsContentProvider, PatternInheritancePage.ParentsContentProvider, PatternSpecificationPage.ParametersContentProvider

public abstract class AbstractPatternPageContentProvider
extends org.eclipse.egf.common.ui.toolkit.viewers.AbstractStructuredContentProvider

Abstract pattern page content provider.
Stands for a structured content provider.
Disable behaviors such as being called on object removal with initial input when closing the view, or possible calls to add/remove/update when the provider is disposed (not observed yet).
Also give access to initial input and viewer.
getInitialInput() and getViewer() methods should be overridden by implementor so as to return correct type (@since java 1.5).


Constructor Summary
AbstractPatternPageContentProvider()
           
 
Method Summary
 void dispose()
           
protected abstract  void doDispose()
          Do dispose provider.
protected abstract  void doHandleElementsAdded(Object addedElements_p)
          Do handle added elements.
protected abstract  void doHandleElementsRemoved(Object removedElements_p)
          Do handle removed elements.
protected abstract  void doHandleElementUpdated(Object oldInput_p, Object newInput_p)
          Do update element.
protected  Object getElement(Object elements_p, Class<?> elementType_p)
          Get first element from elements_p that is of given type.
protected  Object getInitialInput()
          Get initial input.
protected  Viewer getViewer()
          Get viewer.
protected  void handleElementAdded(Viewer viewer_p, Object addedElements_p)
          Called when elements are added in the viewer.
protected  void handleElementRemoved(Viewer viewer_p, Object removedElements_p)
          Called when elements are removed from the viewer.
protected  void handleElementUpdated(Viewer viewer_p, Object oldInput_p, Object newInput_p)
          Called when elements are updated in the viewer.
protected  void handleViewer(Viewer viewer_p)
          Give an opportunity to handle the viewer when AbstractStructuredContentProvider.inputChanged(Viewer, Object, Object) is called.
 void inputChanged(Viewer viewer_p, Object oldInput_p, Object newInput_p)
           
protected  boolean isDisposed()
          Is provider disposed ?
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractPatternPageContentProvider

public AbstractPatternPageContentProvider()
Method Detail

dispose

public void dispose()
See Also:
org.eclipse.jface.viewers.IContentProvider#dispose()

getViewer

protected Viewer getViewer()
Get viewer.

Returns:

getInitialInput

protected Object getInitialInput()
Get initial input.

Returns:

inputChanged

public void inputChanged(Viewer viewer_p,
                         Object oldInput_p,
                         Object newInput_p)
Overrides:
inputChanged in class org.eclipse.egf.common.ui.toolkit.viewers.AbstractStructuredContentProvider
See Also:
org.eclipse.egf.common.ui.toolkit.viewers.AbstractStructuredContentProvider#inputChanged(org.eclipse.jface.viewers.Viewer, java.lang.Object, java.lang.Object)

handleElementAdded

protected void handleElementAdded(Viewer viewer_p,
                                  Object addedElements_p)
Description copied from class: org.eclipse.egf.common.ui.toolkit.viewers.AbstractStructuredContentProvider
Called when elements are added in the viewer.

Specified by:
handleElementAdded in class org.eclipse.egf.common.ui.toolkit.viewers.AbstractStructuredContentProvider
Parameters:
viewer_p - The viewer.
addedElements_p - The elements which are added to this viewer.
See Also:
org.eclipse.egf.common.ui.toolkit.viewers.AbstractStructuredContentProvider#handleElementAdded(org.eclipse.jface.viewers.Viewer, java.lang.Object)

doHandleElementsAdded

protected abstract void doHandleElementsAdded(Object addedElements_p)
Do handle added elements.
If there should be only one element of a given type in added elements, use getElement(Object, Class) to get it.

Parameters:
addedElements_p -

handleElementRemoved

protected void handleElementRemoved(Viewer viewer_p,
                                    Object removedElements_p)
Description copied from class: org.eclipse.egf.common.ui.toolkit.viewers.AbstractStructuredContentProvider
Called when elements are removed from the viewer.

Specified by:
handleElementRemoved in class org.eclipse.egf.common.ui.toolkit.viewers.AbstractStructuredContentProvider
Parameters:
viewer_p - The viewer.
removedElements_p - The elements which are removed from this viewer.
See Also:
org.eclipse.egf.common.ui.toolkit.viewers.AbstractStructuredContentProvider#handleElementRemoved(org.eclipse.jface.viewers.Viewer, java.lang.Object)

doHandleElementsRemoved

protected abstract void doHandleElementsRemoved(Object removedElements_p)
Do handle removed elements.
If there should be only one element of a given type in removed elements, use getElement(Object, Class) to get it.

Parameters:
removedElements_p -

handleElementUpdated

protected void handleElementUpdated(Viewer viewer_p,
                                    Object oldInput_p,
                                    Object newInput_p)
Description copied from class: org.eclipse.egf.common.ui.toolkit.viewers.AbstractStructuredContentProvider
Called when elements are updated in the viewer.

Specified by:
handleElementUpdated in class org.eclipse.egf.common.ui.toolkit.viewers.AbstractStructuredContentProvider
Parameters:
viewer_p - The viewer.
oldInput_p - The old input value.
newInput_p - The new input value.
See Also:
org.eclipse.egf.common.ui.toolkit.viewers.AbstractStructuredContentProvider#handleElementUpdated(org.eclipse.jface.viewers.Viewer, java.lang.Object, java.lang.Object)

doHandleElementUpdated

protected abstract void doHandleElementUpdated(Object oldInput_p,
                                               Object newInput_p)
Do update element.
If there should be only one element of a given type in updated elements, use getElement(Object, Class) to get it.

Parameters:
oldInput_p -
newInput_p -

handleViewer

protected void handleViewer(Viewer viewer_p)
Description copied from class: org.eclipse.egf.common.ui.toolkit.viewers.AbstractStructuredContentProvider
Give an opportunity to handle the viewer when AbstractStructuredContentProvider.inputChanged(Viewer, Object, Object) is called.

Specified by:
handleViewer in class org.eclipse.egf.common.ui.toolkit.viewers.AbstractStructuredContentProvider
Parameters:
viewer_p - The viewer.
See Also:
org.eclipse.egf.common.ui.toolkit.viewers.AbstractStructuredContentProvider#handleViewer(org.eclipse.jface.viewers.Viewer)

getElement

protected Object getElement(Object elements_p,
                            Class<?> elementType_p)
Get first element from elements_p that is of given type.

Parameters:
elements_p -
elementType_p -
Returns:

isDisposed

protected boolean isDisposed()
Is provider disposed ?

Returns:

doDispose

protected abstract void doDispose()
Do dispose provider.


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.