Modelers

org.topcased.modeler.documentation
Class DocPageComposite

java.lang.Object
  extended by org.eclipse.swt.widgets.Widget
      extended by org.eclipse.swt.widgets.Control
          extended by org.eclipse.swt.widgets.Scrollable
              extended by org.eclipse.swt.widgets.Composite
                  extended by org.topcased.modeler.documentation.DocPageComposite
All Implemented Interfaces:
org.eclipse.gef.commands.CommandStackListener, org.eclipse.swt.graphics.Drawable
Direct Known Subclasses:
EAnnotationCommentsComposite, EAnnotationResourcesComposite

public abstract class DocPageComposite
extends org.eclipse.swt.widgets.Composite
implements org.eclipse.gef.commands.CommandStackListener

A class defining an empty composite to use in an IDocPage.
Creation : 10 oct. 2005


Field Summary
 
Fields inherited from class org.eclipse.swt.widgets.Composite
embeddedHandle
 
Fields inherited from class org.eclipse.swt.widgets.Widget
handle
 
Constructor Summary
DocPageComposite(org.eclipse.swt.widgets.Composite parent, int style, org.eclipse.gef.commands.CommandStack stack)
          Construct a new empty DocPageComposite.
 
Method Summary
 void commandStackChanged(java.util.EventObject event)
           
protected abstract  void createContents(org.eclipse.swt.widgets.Composite parent)
          Create the content of this composite.
protected  org.eclipse.gef.commands.CommandStack getCommandStack()
          Return this composite command stack.
protected  EModelElement getModelElement()
          Get the current edited model element.
protected  void handleDispose()
          Called when the composite is disposed.
protected  void refresh()
          Informs this composite that it needs to be refresh.
 void setModelElement(EModelElement modelElement)
          Change the edited object
 
Methods inherited from class org.eclipse.swt.widgets.Composite
changed, checkSubclass, computeSize, getBackgroundMode, getChildren, getClientArea, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList
 
Methods inherited from class org.eclipse.swt.widgets.Scrollable
computeTrim, getBorderWidth, getHorizontalBar, getVerticalBar
 
Methods inherited from class org.eclipse.swt.widgets.Control
addControlListener, addDragDetectListener, addFocusListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTraverseListener, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getParent, getShell, getSize, getToolTipText, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTraverseListener, setBackground, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setParent, setRedraw, setSize, setSize, setToolTipText, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, update
 
Methods inherited from class org.eclipse.swt.widgets.Widget
addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, setData, setData, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DocPageComposite

public DocPageComposite(org.eclipse.swt.widgets.Composite parent,
                        int style,
                        org.eclipse.gef.commands.CommandStack stack)
Construct a new empty DocPageComposite.

Parameters:
parent - the parent composite
style - the composite style
stack - the command stack to use to execute commands
Method Detail

handleDispose

protected void handleDispose()
Called when the composite is disposed. Subclasses must release local resources and listeners here.


setModelElement

public void setModelElement(EModelElement modelElement)
Change the edited object

Parameters:
modelElement - the edited object

getCommandStack

protected org.eclipse.gef.commands.CommandStack getCommandStack()
Return this composite command stack.

Returns:
a command stack

getModelElement

protected EModelElement getModelElement()
Get the current edited model element.

Returns:
a model element

createContents

protected abstract void createContents(org.eclipse.swt.widgets.Composite parent)
Create the content of this composite. Clients should override this method to create their own composite.

Parameters:
parent - the parent composite

refresh

protected void refresh()
Informs this composite that it needs to be refresh.


commandStackChanged

public void commandStackChanged(java.util.EventObject event)
Specified by:
commandStackChanged in interface org.eclipse.gef.commands.CommandStackListener
See Also:
CommandStackListener.commandStackChanged(java.util.EventObject)

Modelers

Copyright (c) 2005 TOPCASED Contributors 2005 - 2007. All rights reserved.