ag.ion.bion.officelayer.internal.desktop
Class Frame

java.lang.Object
  ag.ion.bion.officelayer.internal.desktop.Frame

All Implemented Interfaces:

IFrame

public class Frame
extends java.lang.Object
implements IFrame

OpenOffice.org frame.

Constructor Summary

Frame(com.sun.star.frame.XFrame xFrame, IOfficeConnection officeConnection)
Constructs new Frame.

Frame(com.sun.star.frame.XFrame xFrame, IServiceProvider serviceProvider)
Constructs new Frame.

Method Summary

void	addDispatchDelegate(java.lang.String commandURL, IDispatchDelegate dispatchDelegate) Adds a dispatch delegate for the submitted command URL.
void	close() Closes the frame.
void	disableDispatch(java.lang.String commandURL) Disables the command dispatch related to the submitted command URL.
IDispatch	getDispatch(java.lang.String commandURL) Returns dispatch for the submitted command URL.
ILayoutManager	getLayoutManager() Returns layout manager of the frame.
com.sun.star.frame.XFrame	getXFrame() Returns OpenOffice.org XFrame interface.
void	removeDispatchDelegate(java.lang.String commandURL) Removes the dispatch delegate for the submitted command URL.
void	setFocus() Focuses the frame.
void	showPreview() Aktivates the print preview for the frame.
void	showPreview(int columns, int rows) Aktivates the print preview for the frame with the given columns and rows.
void	updateDispatches() Updates the current dispatches.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Frame

public Frame(com.sun.star.frame.XFrame xFrame,
             IOfficeConnection officeConnection)

Constructs new Frame.

Parameters:

xFrame - OpenOffice.org XFrame interface to be used

officeConnection - office connection to be used

Frame

public Frame(com.sun.star.frame.XFrame xFrame,
             IServiceProvider serviceProvider)

Constructs new Frame.

Parameters:

xFrame - OpenOffice.org XFrame interface to be used

serviceProvider - service provider to be used

Method Detail

getXFrame

public com.sun.star.frame.XFrame getXFrame()

Returns OpenOffice.org XFrame interface. This method is not part of the public API.

Specified by:

getXFrame in interface IFrame

Returns:

OpenOffice.org XFrame interface

getLayoutManager

public ILayoutManager getLayoutManager()
                                throws NOAException

Returns layout manager of the frame. Returns null if a layout manager is not available.

Specified by:

getLayoutManager in interface IFrame

Returns:

layout manager of the frame or null if a layout manager is not available

Throws:

NOAException - if the layout manager can not be requested

disableDispatch

public void disableDispatch(java.lang.String commandURL)

Disables the command dispatch related to the submitted command URL. In order to activate the dispatches you need to call IFrame.updateDispatches().

Specified by:

disableDispatch in interface IFrame

Parameters:

commandURL - URL of the command

See Also:

GlobalCommands

addDispatchDelegate

public void addDispatchDelegate(java.lang.String commandURL,
                                IDispatchDelegate dispatchDelegate)

Adds a dispatch delegate for the submitted command URL. In order to activate the dispatches you need to call IFrame.updateDispatches().

Specified by:

addDispatchDelegate in interface IFrame

Parameters:

commandURL - command URL to be used

dispatchDelegate - dispatch delegate to be added

removeDispatchDelegate

public void removeDispatchDelegate(java.lang.String commandURL)

Removes the dispatch delegate for the submitted command URL. In order to activate the dispatches you need to call IFrame.updateDispatches().

Specified by:

removeDispatchDelegate in interface IFrame

Parameters:

commandURL - command URL to be used

getDispatch

public IDispatch getDispatch(java.lang.String commandURL)
                      throws NOAException

Returns dispatch for the submitted command URL.

Specified by:

getDispatch in interface IFrame

Parameters:

commandURL - command URL of the dispatch

Returns:

dispatch for the submitted command URL

Throws:

NOAException - if a dispatch for the submitted command URL can not be provided

close

public void close()

Closes the frame.

Specified by:

close in interface IFrame

setFocus

public void setFocus()

Focuses the frame.

Specified by:

setFocus in interface IFrame

updateDispatches

public void updateDispatches()

Updates the current dispatches.

Specified by:

updateDispatches in interface IFrame

showPreview

public void showPreview()
                 throws NOAException

Aktivates the print preview for the frame. Default columns and rows is set to one.

Specified by:

showPreview in interface IFrame

Throws:

NOAException - if there is an error showing the preview

showPreview

public void showPreview(int columns,
                        int rows)
                 throws NOAException

Aktivates the print preview for the frame with the given columns and rows.

Specified by:

showPreview in interface IFrame

Parameters:

columns - the number of columns to display

rows - the number of rows to display

Throws:

NOAException - if there is an error showing the preview