com.ibm.commons.swt.controls
Class ShowErrorComposite

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.controls.ShowErrorComposite

All Implemented Interfaces:

ICustomControl, org.eclipse.swt.graphics.Drawable

public class ShowErrorComposite
extends org.eclipse.swt.widgets.Composite
implements ICustomControl

A Composite that shows the contents of a stack trace on a composite. This composite would typically be used if an error/exception was encountered during View/Editor initialization and it is necessary to show some content in the IViewSite/IEditorSite.

Field Summary

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

handle

Constructor Summary

ShowErrorComposite(org.eclipse.swt.widgets.Composite parent, int style, boolean showDetailsByDefault)
Constructs a new instance of the class given the parent Composite, a style value describing its behavior and appearance, and id which can be used to later identify this control.

Method Summary

protected void	createReloadButton() By default do not create a reload button (even if 'hasReloadButton' is set to true).
java.lang.String	getId() Returns a string identifier associated with the current widget/control
static void	main(java.lang.String[] args)
void	setHasDetailsButton(boolean value) Sets whether or not room is allocated in the composite for a "Show Details" button.
void	setHasReloadButton(boolean value) Sets whether or not room is allocated in the composite for a reload button.
void	setId(java.lang.String id) Sets a string identifier on the current widget/control.
void	setInfo(java.lang.String message, org.eclipse.core.runtime.IStatus result) Sets the information to be displayed in the error composite.

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, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTraverseListener, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getParent, getRegion, getShell, getSize, getToolTipText, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTraverseListener, setBackground, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setParent, setRedraw, setRegion, setSize, setSize, setToolTipText, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, traverse, traverse, update

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

addDisposeListener, addListener, checkWidget, dispose, 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

ShowErrorComposite

public ShowErrorComposite(org.eclipse.swt.widgets.Composite parent,
                          int style,
                          boolean showDetailsByDefault)

Constructs a new instance of the class given the parent Composite, a style value describing its behavior and appearance, and id which can be used to later identify this control.

Parameters:

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

style - - the style of the control to construct.

showDetailsByDefault - - a boolean flag that tells the composite to display the details of the exception by default.

Method Detail

setHasReloadButton

public void setHasReloadButton(boolean value)

Sets whether or not room is allocated in the composite for a reload button. The default implementation does not add a button by default. If a reload button is needed then a subclass needs to be implemented with an implementation for the reload button.

Parameters:

value - - boolean

setHasDetailsButton

public void setHasDetailsButton(boolean value)

Sets whether or not room is allocated in the composite for a "Show Details" button. The default implementation allows for the details of the exception shown in the error area to be expanded or collapsed depending on the state of this button.

Parameters:

value - - boolean

createReloadButton

protected void createReloadButton()

By default do not create a reload button (even if 'hasReloadButton' is set to true). If reload behavior is required a subclass has to be created overriding the behavior of this method.

getId

public java.lang.String getId()

Description copied from interface: ICustomControl

Returns a string identifier associated with the current widget/control

Specified by:

getId in interface ICustomControl

Returns:

String

setId

public void setId(java.lang.String id)

Description copied from interface: ICustomControl

Sets a string identifier on the current widget/control.

Specified by:

setId in interface ICustomControl

setInfo

public void setInfo(java.lang.String message,
                    org.eclipse.core.runtime.IStatus result)

Sets the information to be displayed in the error composite. The IStatus will contain the exception information to be displayed. The message parameter should contain some human readable information describing what has gone wrong and what can be done to fix the issue.

Parameters:

message - - String

result - - IStatus

main

public static void main(java.lang.String[] args)