Class ContentPage

java.lang.Object
org.eclipse.swt.widgets.Widget
org.eclipse.swt.widgets.Control
org.eclipse.swt.widgets.Scrollable
org.eclipse.swt.widgets.Composite
com.ibm.mq.explorer.ui.internal.content.ContentPageBase
com.ibm.mq.explorer.ui.extensions.ContentPage
All Implemented Interfaces:
org.eclipse.swt.graphics.Drawable

public abstract class ContentPage extends com.ibm.mq.explorer.ui.internal.content.ContentPageBase
Abstract class for classes providing Content Pages to the MQ Content View
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    Common copyright notice
    static final String
    CMVC descriptors - expanded during extraction

    Fields inherited from class org.eclipse.swt.widgets.Composite

    embeddedHandle

    Fields inherited from class org.eclipse.swt.widgets.Widget

    handle
  • Constructor Summary

    Constructors
    Constructor
    Description
    ContentPage(org.eclipse.swt.widgets.Composite parent, int style)
    Constructor
  • Method Summary

    Modifier and Type
    Method
    Description
    abstract String
    Gets the page identifier
    abstract void
    Create and initialise the static widgets and controls for this page
    abstract void
    Notification that the instance of this content page associated with the specified object is being deleted
    abstract boolean
    Get whether to enable the Refresh toolbar button / menu item
    abstract boolean
    Get whether to enable the Show System Objects toolbar button / menu item
    abstract void
    Refresh the page with the data from the object.
    abstract void
    Repaint the content page.
    abstract void
    Set the object which the page will use when refreshing its contents
    abstract void
    showSystemObjects(boolean show)
    Set whether system objects should be shown
    abstract void
    Update the page with the data from the object.

    Methods inherited from class com.ibm.mq.explorer.ui.internal.content.ContentPageBase

    getViewPart, setActive, setOwningContentPage, setViewPart

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

    changed, drawBackground, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, layout, setBackgroundMode, setFocus, setLayout, setLayoutDeferred, setTabList, toString

    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, 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, isAutoScalable, 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, dispose, getData, getData, getDisplay, getListeners, getStyle, isAutoDirection, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, reskin, setData, setData

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Field Details

  • Constructor Details

    • ContentPage

      public ContentPage(org.eclipse.swt.widgets.Composite parent, int style)
      Constructor
      Parameters:
      parent - the parent composite to use
      style - the SWT style flags to use
  • Method Details

    • init

      public abstract void init()
      Create and initialise the static widgets and controls for this page
    • getId

      public abstract String getId()
      Gets the page identifier
      Returns:
      String the page identifier
    • setObject

      public abstract void setObject(MQExtObject object)
      Set the object which the page will use when refreshing its contents
      Parameters:
      object - the object the page will use when refreshing its contents
    • updatePage

      public abstract void updatePage()
      Update the page with the data from the object. When a different TreeNode is selected, explorer calls this method to update the page based on the object associated with the TreeNode which has been has already been set for this page
    • refresh

      public abstract void refresh()
      Refresh the page with the data from the object. When the "refresh" button is pressed, explorer calls this method to refresh and update the page based on the object which has been set for this page
    • repaint

      public abstract void repaint()
      Repaint the content page. This is called from the refresh() method to redraw the content page. This will in turn update any other objects on the page. This simply updates the objects based on the underlying data, and does not cause any update of the data to happen.
    • isEnableRefreshAction

      public abstract boolean isEnableRefreshAction()
      Get whether to enable the Refresh toolbar button / menu item
      Returns:
      true if the Refresh action is to be enabled, false otherwise
    • isEnableSystemObjectsAction

      public abstract boolean isEnableSystemObjectsAction()
      Get whether to enable the Show System Objects toolbar button / menu item
      Returns:
      true if the Show System Objects action is to be enabled, false otherwise
    • showSystemObjects

      public abstract void showSystemObjects(boolean show)
      Set whether system objects should be shown
      Parameters:
      show - true if system objects should be shown, false otherwise
    • instanceDeleted

      public abstract void instanceDeleted(Object object)
      Notification that the instance of this content page associated with the specified object is being deleted
      Parameters:
      object - the object identifying the instance being deleted