ag.ion.noa4e.ui.widgets
Class OfficePanel

java.lang.Object
  org.eclipse.swt.widgets.Widget
      org.eclipse.swt.widgets.Control
          org.eclipse.swt.widgets.Scrollable
              org.eclipse.swt.widgets.Composite
                  ag.ion.noa4e.ui.widgets.OfficePanel

All Implemented Interfaces:

org.eclipse.swt.graphics.Drawable

public class OfficePanel
extends org.eclipse.swt.widgets.Composite

The office panel can be used in order to integrate the OpenOffice.org User Interface into the SWT environment.

Field Summary

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

view

Constructor Summary

OfficePanel(org.eclipse.swt.widgets.Composite parent, int style)
Constructs new OfficePanel.

Method Summary

protected void	buildProgressIndicator(org.eclipse.swt.widgets.Composite parent) Builds progress indicator.
void	dispose() Disposes the office panel.
protected void	documentLoadingOperationDone() Is called after a document loading operation was done.
IDocument	getDocument() Returns current document.
IFrame	getFrame() Returns current office frame.
org.eclipse.core.runtime.IStatus	getLastLoadingStatus() Returns status of the last document loading.
protected IOfficeApplication	getOfficeApplication() Returns office application.
protected org.eclipse.core.runtime.IProgressMonitor	getProgressMonitor() Returns progress monitor.
protected void	hideProgressIndicator() Hides the progress indicator.
void	loadDocument(boolean fork, java.lang.String documentPath, IDocumentDescriptor documentDescriptor) Loads document into the office panel.
void	setBuildAlwaysNewFrames(boolean buildAlwaysNewFrames) Sets information whether a new frame should be builded for new loaded documents.
boolean	setFocus() Sets focus to the office panel.
void	setLayout(org.eclipse.swt.widgets.Layout layout) Sets the layout which is associated with the receiver to be the argument which may be null.
protected void	showProgressIndicator() Shows progress indicator.
void	showProgressIndicator(boolean showProgressIndicator) Sets information whether a progress indicator should be shown during document loading.
protected org.eclipse.core.runtime.IStatus	startOfficeApplication(IOfficeApplication officeApplication) Starts office application.

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

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, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBorderWidth, 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

OfficePanel

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

Constructs new OfficePanel.

Parameters:

parent - parent to be used

style - style to be used

Method Detail

getFrame

public IFrame getFrame()

Returns current office frame. Returns null if an office frame is not available.

Returns:

current office frame or null if an office frame is not available

getDocument

public IDocument getDocument()

Returns current document. Returns null if a document is not available.

Returns:

current document. Returns null if a document is not available.

setFocus

public boolean setFocus()

Sets focus to the office panel.

Overrides:

setFocus in class org.eclipse.swt.widgets.Composite

setBuildAlwaysNewFrames

public void setBuildAlwaysNewFrames(boolean buildAlwaysNewFrames)

Sets information whether a new frame should be builded for new loaded documents. The default value is false.

Parameters:

buildAlwaysNewFrames - information whether a new frame should be builded for new loaded documents

showProgressIndicator

public void showProgressIndicator(boolean showProgressIndicator)

Sets information whether a progress indicator should be shown during document loading. The default value is true.

Parameters:

showProgressIndicator - information whether a progress indicator should be shown during document loading

loadDocument

public final void loadDocument(boolean fork,
                               java.lang.String documentPath,
                               IDocumentDescriptor documentDescriptor)

Loads document into the office panel.

Parameters:

fork - information whether the loading should be done in an own thread

documentPath - path of the document to be loaded

documentDescriptor - document descriptor to be used

dispose

public void dispose()

Disposes the office panel.

Overrides:

dispose in class org.eclipse.swt.widgets.Widget

getLastLoadingStatus

public org.eclipse.core.runtime.IStatus getLastLoadingStatus()

Returns status of the last document loading. Returns null if a status is not available.

Returns:

status of the last document loading or null if a status is not available

setLayout

public void setLayout(org.eclipse.swt.widgets.Layout layout)

Sets the layout which is associated with the receiver to be the argument which may be null.

Overrides:

setLayout in class org.eclipse.swt.widgets.Composite

Parameters:

layout - the receiver's new layout or null

Throws:

org.eclipse.swt.SWTException -

• ERROR_WIDGET_DISPOSED - if the receiver has been disposed
• ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver

documentLoadingOperationDone

protected void documentLoadingOperationDone()

Is called after a document loading operation was done. This method can be overwriten by subclasses in order to do some work after a document loading operation was done.

getProgressMonitor

protected org.eclipse.core.runtime.IProgressMonitor getProgressMonitor()

Returns progress monitor. Subclasses can overwrite this method in order to provide their own progress monitor.

Returns:

progress monitor

getOfficeApplication

protected IOfficeApplication getOfficeApplication()

Returns office application.

Returns:

office application

startOfficeApplication

protected org.eclipse.core.runtime.IStatus startOfficeApplication(IOfficeApplication officeApplication)

Starts office application.

Parameters:

officeApplication - office application to be started

Returns:

information whether the office application was started

buildProgressIndicator

protected void buildProgressIndicator(org.eclipse.swt.widgets.Composite parent)

Builds progress indicator. Subclasses can overwrite this method in order to provide their own progress indicator.

Parameters:

parent - parent to be used

showProgressIndicator

protected void showProgressIndicator()

Shows progress indicator. Subclasses can overwrite this method in order to show their own progress indicator.

hideProgressIndicator

protected void hideProgressIndicator()

Hides the progress indicator. Subclasses can overwrite this method in order to hide their own progress indicator.