ag.ion.bion.officelayer.desktop
Interface IFrame

All Known Implementing Classes:

Frame

public interface IFrame

OpenOffice.org 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.

Method Detail

getXFrame

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

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

Returns:

OpenOffice.org XFrame interface

getLayoutManager

ILayoutManager getLayoutManager()
                                throws NOAException

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

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

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 updateDispatches().

Parameters:

commandURL - URL of the command

See Also:

GlobalCommands

addDispatchDelegate

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 updateDispatches().

Parameters:

commandURL - command URL to be used

dispatchDelegate - dispatch delegate to be added

removeDispatchDelegate

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 updateDispatches().

Parameters:

commandURL - command URL to be used

getDispatch

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

Returns dispatch for the submitted command URL.

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

void close()

Closes the frame.

setFocus

void setFocus()

Focuses the frame.

updateDispatches

void updateDispatches()

Updates the current dispatches.

showPreview

void showPreview()
                 throws NOAException

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

Throws:

NOAException - if there is an error showing the preview

showPreview

void showPreview(int columns,
                 int rows)
                 throws NOAException

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

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