Package net.ssehub.easy.producer.ui.productline_editor

Class AbstractEASyEditorPage

    • Constructor Summary

      Constructors 
      Constructor Description
      AbstractEASyEditorPage​(ProductLineProject plp, java.lang.String title, org.eclipse.swt.widgets.Composite parent)
      Sole constructor for this class.

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract void close()
      Optional method for specifying an on-closed action.
      protected org.eclipse.ui.forms.widgets.Form createForm()
      Creates a form widget in the getContentPane().
      protected org.eclipse.swt.widgets.Composite createSection​(java.lang.String title, java.lang.String description, int gridStyle)
      Creates a new subsection inside the current page.
      protected org.eclipse.swt.widgets.Composite createSection​(java.lang.String title, java.lang.String description, int style, int gridStyle)
      Creates a new subsection inside the current page.
      void dispose()  
      protected boolean doSave()
      Is called by the parent to perform save operations if needed.
      org.eclipse.swt.widgets.Composite getContentPane()
      Returns the content pane of this editor page.
      protected ProductLineProject getProductLineProject()
      Returns the ProductLineProject currently edited by this editor.
      protected org.eclipse.ui.forms.widgets.FormToolkit getToolkit()
      Returns the toolkit for creating new widgets.
      protected abstract void pageActivated()
      This method will be called, when this editor page becomes active.
      void pageChanged​(org.eclipse.jface.dialogs.PageChangedEvent event)  
      void register​(IEASyPageListener listener)
      Registers a new IEASyPageListener which will be informed when this page becomes dirty.
      void setDirty()
      Informs all IEASyPageListener that this page became dirty.
      boolean setFocus()  

      • Methods inherited from class org.eclipse.swt.widgets.Composite

        changed, checkSubclass, computeSize, drawBackground, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, layout, setBackgroundMode, setLayout, setLayoutDeferred, setTabList

      • Methods inherited from class org.eclipse.swt.widgets.Scrollable

        computeTrim, getClientArea, getHorizontalBar, getScrollbarsMode, getVerticalBar

      • Methods inherited from class org.eclipse.swt.widgets.Control

        addControlListener, addDragDetectListener, addFocusListener, addGestureListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTouchListener, addTraverseListener, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBorderWidth, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getRegion, getShell, getSize, getTextDirection, getToolTipText, getTouchEnabled, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeGestureListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTouchListener, removeTraverseListener, requestLayout, setBackground, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRedraw, setRegion, setSize, setSize, setTextDirection, setToolTipText, setTouchEnabled, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, traverse, traverse, update

      • Methods inherited from class org.eclipse.swt.widgets.Widget

        addDisposeListener, addListener, checkWidget, getData, getData, getDisplay, getListeners, getStyle, isAutoDirection, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, reskin, setData, setData, toString

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface org.eclipse.swt.graphics.Drawable

        isAutoScalable

      • Methods inherited from interface org.eclipse.ui.IPropertyListener

        propertyChanged

    • Field Detail

      • toolkit

        private org.eclipse.ui.forms.widgets.FormToolkit toolkit

      • contentPane

        private org.eclipse.ui.forms.widgets.ScrolledForm contentPane

    • Constructor Detail

      • AbstractEASyEditorPage

        public AbstractEASyEditorPage​(ProductLineProject plp,
                              java.lang.String title,
                              org.eclipse.swt.widgets.Composite parent)
        Sole constructor for this class.
        Parameters:
        plp - The ProductLineProject edited in this editor page.
        title - The title for this editor page.
        parent - The parent, holding this editor page.

    • Method Detail

      • setFocus

        public boolean setFocus()
        Overrides:
        setFocus in class org.eclipse.swt.widgets.Composite

      • getContentPane

        public final org.eclipse.swt.widgets.Composite getContentPane()
        Returns the content pane of this editor page.
        Specified by:
        getContentPane in interface IEASyEditorPage
        Returns:
        The content pane of this editor page

      • pageActivated

        protected abstract void pageActivated()
        This method will be called, when this editor page becomes active.

      • pageChanged

        public final void pageChanged​(org.eclipse.jface.dialogs.PageChangedEvent event)
        Specified by:
        pageChanged in interface org.eclipse.jface.dialogs.IPageChangedListener

      • dispose

        public void dispose()
        Overrides:
        dispose in class org.eclipse.swt.widgets.Widget

      • close

        public abstract void close()
        Optional method for specifying an on-closed action.

      • createForm

        protected org.eclipse.ui.forms.widgets.Form createForm()
        Creates a form widget in the getContentPane(). Note that this widget does not scroll its content, so make sure there is a scrolled composite up the parent chain. If you require scrolling, use 'createScrolledForm' instead.
        Returns:
        the form that does not scroll

      • getToolkit

        protected org.eclipse.ui.forms.widgets.FormToolkit getToolkit()
        Returns the toolkit for creating new widgets.
        Returns:
        Toolkit for creating new widgets

      • createSection

        protected org.eclipse.swt.widgets.Composite createSection​(java.lang.String title,
                                                          java.lang.String description,
                                                          int gridStyle)
        Creates a new subsection inside the current page. This subsection has its own heading and can be (un-)folded.
        Parameters:
        title - The title of the section
        description - The description of the section (will be shown directly under the title)
        gridStyle - A GridData constants for configuring the behavior of the section. Usually, GridData.FILL_HORIZONTAL should be appropriate.
        Returns:
        A new composite where new elements can be added to. The newly created composite must be configured with a GridLayout otherwise nested elements will not be displayed.
        See Also:
        createSection(String, String, int, int)

      • createSection

        protected org.eclipse.swt.widgets.Composite createSection​(java.lang.String title,
                                                          java.lang.String description,
                                                          int style,
                                                          int gridStyle)
        Creates a new subsection inside the current page. This subsection has its own heading and can be (un-)folded.
        Parameters:
        title - The title of the section
        description - The description of the section (will be shown directly under the title)
        style - the section style (use SWT constants).
        gridStyle - A GridData constants for configuring the behavior of the section. Usually, GridData.FILL_HORIZONTAL should be appropriate.
        Returns:
        A new composite where new elements can be added to. The newly created composite must be configured with a GridLayout otherwise nested elements will not be displayed.
        See Also:
        createSection(String, String, int)

      • doSave

        protected boolean doSave()
        Is called by the parent to perform save operations if needed.
        Returns:
        true if save was needed and performed, false else