Class PropertyPage

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.properties.CustomPropertyPage
com.ibm.mq.explorer.ui.internal.properties.PropertyPageBase
com.ibm.mq.explorer.ui.extensions.PropertyPage
All Implemented Interfaces:
org.eclipse.swt.graphics.Drawable

public abstract class PropertyPage extends com.ibm.mq.explorer.ui.internal.properties.PropertyPageBase
Abstract class for classes defining property pages for corresponding property tabs in a property dialog
  • 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
    PropertyPage(org.eclipse.swt.widgets.Composite parent, int style, MQExtObject mqExtObj, Object internalObj, boolean readonly)
    Constructor
  • Method Summary

    Modifier and Type
    Method
    Description
    abstract void
    Notification that Apply has been pressed.
    abstract String
    Returns the String to be displayed on the busy dialog that is displayed when asynchronously applying changes
    abstract void
    Create and initialise the widgets and controls for this page
    abstract boolean
    Return whether any attribute controls on the page are enabled, and therefore the Apply button should be enabled
    abstract boolean
    Return whether or not any attribute values have changed on this page and therefore whether the changes will need to be applied.

    Methods inherited from class com.ibm.mq.explorer.ui.internal.properties.PropertyPageBase

    apply, changesApplied, init, isAnyControlEnabled, restoreDefaults

    Methods inherited from class com.ibm.mq.explorer.ui.internal.properties.CustomPropertyPage

    addUnexpectedAttributes, getFixedSpaceFont, getUiDisplayGroup, setFixedSpaceFont

    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

    • PropertyPage

      public PropertyPage(org.eclipse.swt.widgets.Composite parent, int style, MQExtObject mqExtObj, Object internalObj, boolean readonly)
      Constructor
      Parameters:
      parent - the parent composite
      style - the SWT style flags to use
      mqExtObj - the object for which the property page is for
      internalObj - an internal MQ Object
      readonly - whether the controls should be readonly
  • Method Details

    • init

      public abstract void init()
      Create and initialise the widgets and controls for this page
      Specified by:
      init in class com.ibm.mq.explorer.ui.internal.properties.PropertyPageBase
    • apply

      public abstract void apply()
      Notification that Apply has been pressed. This method should contain the code that will be used to apply changes as a result of properties being altered on the custom page. The method is invoked each time the user hits apply or OK. Any updates to UI widgets must be done within an asyncExec. An example of this is given below:
       parent.getDisplay().asyncExec(new Runnable() {
       
         public void run() {
           //Get the text from the input text box
           String name = nameText.getText();
           //Update the message label
           messageLabel.setText("Hello " + name); //$NON-NLS-1$
         }
       });
       
      Specified by:
      apply in class com.ibm.mq.explorer.ui.internal.properties.PropertyPageBase
    • isAnyControlEnabled

      public abstract boolean isAnyControlEnabled()
      Return whether any attribute controls on the page are enabled, and therefore the Apply button should be enabled
      Specified by:
      isAnyControlEnabled in class com.ibm.mq.explorer.ui.internal.properties.PropertyPageBase
      Returns:
      boolean true if any attribute controls are enabled, false otherwise
    • isChanged

      public abstract boolean isChanged()
      Return whether or not any attribute values have changed on this page and therefore whether the changes will need to be applied. It is assumed that this is a constant time operation.
      Specified by:
      isChanged in class com.ibm.mq.explorer.ui.internal.properties.PropertyPageBase
      Returns:
      boolean true if any attribute values have changed on this page, false otherwise
    • getBusyDialogText

      public abstract String getBusyDialogText()
      Returns the String to be displayed on the busy dialog that is displayed when asynchronously applying changes
      Specified by:
      getBusyDialogText in class com.ibm.mq.explorer.ui.internal.properties.PropertyPageBase
      Returns:
      the String to be displayed on the busy dialog that is displayed when asynchonously applying changes