com.ibm.designer.ide.xsp.components.api.panels.extlib
Class JavaControlDojoPanel

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.extlib.JavaControlDojoPanel

All Implemented Interfaces:

IPanelDataReciever, org.eclipse.swt.graphics.Drawable

public class JavaControlDojoPanel
extends PropLayout2
implements IPanelDataReciever

A default property panel that is generated for an XPage control that has a dojoType attribute. The panel allows users to set a dojoType and dojoAttributes on a control.

By default the property panel framework will examine the FacesRegistry to determine if any attribute named "dojoAttributes" has been defined for the given control. If the "dojoAttributes" has been defined then this panel will be added as one of the property panels for the given control.
Clients may extend this panel, though it is not advisable. Clients may also reference this class directly from their own instances of IPanelsFactory.

See Also:

IPanelsFactory

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

JavaControlDojoPanel(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.

JavaControlDojoPanel(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 void	createLeftContents(org.eclipse.swt.widgets.Composite leftChild) Create the controls that go in the left column.
protected java.lang.String	getContextHelpId() Returns a fully qualified context ID that is to be used as the help id for the panel/composite.
protected int	getNumLeftColumns() Return the number of columns in the left child composite.
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, createRightContents, 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, 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

JavaControlDojoPanel

public JavaControlDojoPanel(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

JavaControlDojoPanel

public JavaControlDojoPanel(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 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

createLeftContents

protected void createLeftContents(org.eclipse.swt.widgets.Composite leftChild)

Description copied from class: PropLayout2

Create the controls that go in the left column.

Subclasses SHOULD override this method

Overrides:

createLeftContents in class PropLayout2

Parameters:

leftChild - the left child Composite

getNumLeftColumns

protected int getNumLeftColumns()

Description copied from class: PropLayout2

Return the number of columns in the left child composite.

Overrides:

getNumLeftColumns in class PropLayout2

Returns:

returns 2 by default

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

getContextHelpId

protected java.lang.String getContextHelpId()

Description copied from class: PropLayout

Returns a fully qualified context ID that is to be used as the help id for the panel/composite.

Overrides:

getContextHelpId in class PropLayout

Returns:

a context id that included the qualified plugin name where the help resides