com.ibm.designer.ide.xsp.components.api.panels
Class XSPPropLayout2

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.commons.swt.data.layouts.PropLayout
                      com.ibm.commons.swt.data.layouts.PropLayout2
                          com.ibm.designer.ide.xsp.components.api.panels.XSPPropLayout2

All Implemented Interfaces:

IPanelDataReciever, org.eclipse.swt.graphics.Drawable

Direct Known Subclasses:

com.ibm.designer.ide.xsp.components.internal.panels.format.AbstractStylePanel

public class XSPPropLayout2
extends PropLayout2
implements IPanelDataReciever

A Composite that has two primary columns. The Composite is 'XPage aware', meaning if it is used as the basis for an XPage properties panel it will be automatically provided with a IPanelExtraData object.

Field Summary

Fields inherited from class com.ibm.commons.swt.data.layouts.PropLayout

TEXT_SUFFIX, UNITS_SUFFIX

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

handle

Constructor Summary

XSPPropLayout2(org.eclipse.swt.widgets.Composite parent, int style)
Constructs a new instance of the class given the parent Composite, and style flags which are used to set the look/behavior of the control.

XSPPropLayout2(org.eclipse.swt.widgets.Composite parent, int style, boolean useFirstColumn, boolean useSecondColumn)
Constructs a new instance of the class given the parent Composite, and style flags which are used to set the look/behavior of the control.

Method Summary

protected IPanelExtraData	getExtraData() Returns the IPanelExtraData associated with this panel.
protected void	initPropertyEditor(PropertyEditor propertyEditor, java.lang.String attrName) A utility method that allows the caller to initialize a property editor with a given attribute and the workbench data associated with the current panel (i.e.
void	setExtraData(IPanelExtraData data) Sets the extra panel data on the current panel.

Methods inherited from class com.ibm.commons.swt.data.layouts.PropLayout2

createChildComposites, createColumnGridData, createContents, createLeftContents, createRightContents, getNumLeftColumns, getNumParentColumns, getNumRightColumns, isFirstColumnUsed, isSecondColumnUsed

Methods inherited from class com.ibm.commons.swt.data.layouts.PropLayout

addStateDependantChild, afterPanelCreation, cacheToolTip, checkEnableText, checkSelection, createChildLayout, createColorButton, createCombo, createCombo, createComboComputed, createComboComputed, createComboComputed, createComboComputed, createControlGDBigWidth, createControlGDDefWidth, createControlGDFill, createControlGDMultiLine, createControlGDNoWidth, createControlGDSmallWidth, createControlNonComputedGD, createDCCheckBox, createDCCheckBox, createDCCheckboxComputed, createDCCheckboxComputed, createDCCheckboxComputed, createDCCheckboxComputed, createDCLabel, createDCRadioButton, createDCText, createDCText, createDCTextComputed, createDCTextComputed, createDCTextComputed, createDCTextComputed, createDCTextComputedPositiveIntegerOnly, createDCTextNoWidth, createExtraIndentGD, createFillGD, createFillSpanGD, createFormatBean, createGroupBoxGridData, createGroupBoxLayout, createHeading, createHeightWidthSection, createIndentGD, createLabel, createLabel, createLabelSpanGD, createMultiLineText, createMultiLineTextComputed, createNoMarginGridLayout, createPanel, createResetButton, createResetButton, createSizeTextGD, createSpanGD, createTableSpanGD, createToggleButton, createUnitsGD, createUnitsTextAndCombo, createUnitsTextAndCombo, dispose, finishCreation, getComputedExtraWidthHint, getContextHelpId, getControlBigWidthHint, getControlForText, getControlForUnits, getControlIndentAmt, getControlSmallWidthHint, getControlWidthHint, getCSSLookup, getCurrentParent, getDataNode, getDefaultBackgroundColor, getDefaultTextCols, getExtraIndentAmt, getFigureContext, getHeightHint, getLabelToolTipText, getResetImage, handleTooltip, initialize, initLayout, installScrolledCompositeListeners, panelCreated, removeStateDependantChild, resetControlListeners, runAfterCreation, setCurrentParent, setFigureContext, showTooltips, useDCPanel

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, setFocus, setLayout, setLayoutDeferred, setTabList

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

computeTrim, getBorderWidth, getClientArea, getHorizontalBar, 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, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getOrientation, getParent, getRegion, getShell, getSize, 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, setBackground, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setOrientation, setParent, setRedraw, setRegion, setSize, setSize, 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, 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

Constructor Detail

XSPPropLayout2

public XSPPropLayout2(org.eclipse.swt.widgets.Composite parent,
                      int style)

Constructs a new instance of the class given the parent Composite, and style flags which are used to set the look/behavior of the control. The Composite creates an outter column control which contains an inner Composite with x number of columns. The number of columns is defined by #getNumChildColumns().

The style value is either one of the style constants defined in class SWT which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the int "|" operator) two or more of those SWT style constants. Style bits are also inherited from superclasses.

Parameters:

parent - a Composite control which will be the parent of the new instance (CANNOT be null).

style - the style of control to construct

XSPPropLayout2

public XSPPropLayout2(org.eclipse.swt.widgets.Composite parent,
                      int style,
                      boolean useFirstColumn,
                      boolean useSecondColumn)

Constructs a new instance of the class given the parent Composite, and style flags which are used to set the look/behavior of the control. The Composite creates two outter columns which contain an inner Composite with x number of columns. The number of inner columns is defined by PropLayout2.getNumLeftColumns() and PropLayout2.getNumRightColumns().

The style value is either one of the style constants defined in class SWT which is applicable to instances of this class, or must be built by bitwise OR'ing together (that is, using the int "|" operator) two or more of those SWT style constants. Style bits are also inherited from superclasses.

Parameters:

parent - a Composite control which will be the parent of the new instance (CANNOT be null).

style - the style of control to construct

useFirstColumn - determines whether or not the first column is rendered

useSecondColumn - determines whether or not the second column is rendered

Method Detail

getExtraData

protected IPanelExtraData getExtraData()

Returns the IPanelExtraData associated with this panel.

Returns:

a IPanelExtraData object, may be null

setExtraData

public void setExtraData(IPanelExtraData data)

Description copied from interface: IPanelDataReciever

Sets the extra panel data on the current panel. The data contained in IPanelExtraData is data that is typically very useful when working within a properties panel, data such as the current db etc.

Specified by:

setExtraData in interface IPanelDataReciever

Parameters:

data - extra data which might be needed when creating a properties panel

initPropertyEditor

protected void initPropertyEditor(PropertyEditor propertyEditor,
                                  java.lang.String attrName)

A utility method that allows the caller to initialize a property editor with a given attribute and the workbench data associated with the current panel (i.e. selected node, current workbench part etc..).

Parameters:

propertyEditor - the property editor to initialize

attrName - the name of the attribute that the property editor is to represent