EGF Engine
Release 0.1.0

org.eclipse.egf.common.ui.viewers
Class AbstractViewerWithButtons

java.lang.Object
  extended by org.eclipse.egf.common.ui.viewers.AbstractViewerWithButtons
Direct Known Subclasses:
OrderedListViewer, ViewerWithAddAndRemove

public abstract class AbstractViewerWithButtons
extends Object

Base class to implement a viewer with buttons located on the right side(e.g to change list elements order).


Nested Class Summary
 class AbstractViewerWithButtons.ButtonData
          Button data.
 
Field Summary
protected  AbstractViewerWithButtons.ButtonData[] _buttonData
          Button data related to created buttons on the right side of this viewer.
protected  StructuredViewer _decoratedViewer
          The decorated viewer.
 
Constructor Summary
protected AbstractViewerWithButtons()
          Default constructor.
protected AbstractViewerWithButtons(Composite parent_p)
          Constructor with no information on buttons.
 
Method Summary
protected  void buttonSelected(Button selectedButton_p, Object data_p)
          Called when a button is selected.
protected  Button createButton(Composite parent_p, String label_p, int style_p)
          Create a button.
protected abstract  AbstractViewerWithButtons.ButtonData[] createButtonData()
          Create button data, that is an array of AbstractViewerWithButtons.ButtonData, descriptors for buttons to create.
protected  Label createEmptySpace(Composite parent_p, int span_p)
          Create an empty space.
protected abstract  StructuredViewer createViewer(Composite composite_p)
          Create a viewer which is decorated with buttons on the right side.
 StructuredViewer getDecoratedViewer()
          Return the decorated viewer.
protected  void init(Composite parent_p)
          Initialize viewer content.
protected  boolean isEditable()
          Is viewer editable ?
 void setButtonClickedListener(IButtonClickedListener buttonClickedListener_p)
          Set the listener that is called when a button is clicked.
protected  void updateButtons(ISelection selection_p)
          Update the buttons enablement property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_buttonData

protected AbstractViewerWithButtons.ButtonData[] _buttonData
Button data related to created buttons on the right side of this viewer.


_decoratedViewer

protected StructuredViewer _decoratedViewer
The decorated viewer.

Constructor Detail

AbstractViewerWithButtons

protected AbstractViewerWithButtons()
Default constructor.
Need to call init(Composite) explicitly in implementation.


AbstractViewerWithButtons

protected AbstractViewerWithButtons(Composite parent_p)
Constructor with no information on buttons.
Calls #getButtonData() to resolve buttons information.

Parameters:
parent_p -
Method Detail

init

protected void init(Composite parent_p)
Initialize viewer content.

Parameters:
parent_p -

isEditable

protected boolean isEditable()
Is viewer editable ? If not, buttons are disabled.

Returns:

updateButtons

protected void updateButtons(ISelection selection_p)
Update the buttons enablement property.

Parameters:
selection_p -

createButtonData

protected abstract AbstractViewerWithButtons.ButtonData[] createButtonData()
Create button data, that is an array of AbstractViewerWithButtons.ButtonData, descriptors for buttons to create.

Returns:
must not return null or an empty array.

createViewer

protected abstract StructuredViewer createViewer(Composite composite_p)
Create a viewer which is decorated with buttons on the right side.

Parameters:
composite_p -

buttonSelected

protected void buttonSelected(Button selectedButton_p,
                              Object data_p)
Called when a button is selected.

Parameters:
selectedButton_p -
data_p - user data

createButton

protected Button createButton(Composite parent_p,
                              String label_p,
                              int style_p)
Create a button.

Parameters:
parent_p -
label_p -
style_p -
Returns:
a not null Button

createEmptySpace

protected Label createEmptySpace(Composite parent_p,
                                 int span_p)
Create an empty space.

Parameters:
parent_p -
span_p -
Returns:

getDecoratedViewer

public StructuredViewer getDecoratedViewer()
Return the decorated viewer.

Returns:
the decoratedViewer

setButtonClickedListener

public void setButtonClickedListener(IButtonClickedListener buttonClickedListener_p)
Set the listener that is called when a button is clicked.

Parameters:
buttonClickedListener_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.