org.fit.layout.gui

Interface Browser

public interface Browser

A GUI browser interface used for creating browser plugins.

Author:

burgetr

Method Summary

Modifier and Type	Method and Description
void	addAreaSelectionListener(AreaSelectionListener listener) Registers an area selection listener that is notified when the area selection changes.
void	addInfoPanel(JComponent component, double weighty) Adds a new panel to the details area.
void	addRectangleSelectionListener(RectangleSelectionListener listener) Registers a rectangle selection listener that is notified when a new rectangle is selected.
void	addStructurePanel(String title, JComponent component) Adds a new tab to the structure view tabs.
void	addToolBar(JToolBar toolbar) Adds a toolbar to the browser's toolbar area.
void	addToolPanel(String title, JComponent component) Adds a new tab to the tool panel at the top of the window
void	addTreeListener(TreeListener listener) Registers an area selection listener that is notified when some tree is updated.
void	clearSelection() Clears the graphical selection.
void	displayErrorMessage(String text) Displays an error message dialog.
void	displayInfoMessage(String text) Displays an info message dialog.
AreaTree	getAreaTree() Gets the area tree of the current page
LogicalAreaTree	getLogicalTree() Gets the logical area tree of the actual page
OutputDisplay	getOutputDisplay() Gets the browser page output display.
Page	getPage() Gets the actual page model
Area	getSelectedArea() Gets the last selected visual area.
void	redrawPage() Redraws the page contents.
void	refreshView() Updates the tree views after some trees have been changed.
void	removeRectangleSelectionListener(RectangleSelectionListener listener) Unregisters a rectangle selection listener.
void	setAreaTree(AreaTree areaTree) Sets area tree from external source
void	setLogicalTree(LogicalAreaTree logicalTree) Sets logical area tree from external source
void	setPage(Page page) Sets page model from the external source
void	setSelection(Rectangular rect) Graphically selects a rectangular area in the browser window.
void	updateDisplay() Performs the output display refresh (when something has been painted).

Method Detail

addToolBar

void addToolBar(JToolBar toolbar)

Adds a toolbar to the browser's toolbar area.

Parameters:

toolbar - the toolbar to be added

addToolPanel

void addToolPanel(String title,
                  JComponent component)

Adds a new tab to the tool panel at the top of the window

Parameters:

title - the tab title

component - the component to be added

addStructurePanel

void addStructurePanel(String title,
                       JComponent component)

Adds a new tab to the structure view tabs.

Parameters:

title - the tab title

component - the component to be added

addInfoPanel

void addInfoPanel(JComponent component,
                  double weighty)

Adds a new panel to the details area.

Parameters:

component - the component to be added

weighty - the resizing vertical weight

getOutputDisplay

OutputDisplay getOutputDisplay()

Gets the browser page output display.

Returns:

the output display

updateDisplay

void updateDisplay()

Performs the output display refresh (when something has been painted).

redrawPage

void redrawPage()

Redraws the page contents. Clears the selection, highlighting etc.

getSelectedArea

Area getSelectedArea()

Gets the last selected visual area.

Returns:

the selected visual area or null when nothing is selected

addAreaSelectionListener

void addAreaSelectionListener(AreaSelectionListener listener)

Registers an area selection listener that is notified when the area selection changes.

Parameters:

listener - the listener to be registered

addTreeListener

void addTreeListener(TreeListener listener)

Registers an area selection listener that is notified when some tree is updated.

Parameters:

listener - the listener to be registered

addRectangleSelectionListener

void addRectangleSelectionListener(RectangleSelectionListener listener)

Registers a rectangle selection listener that is notified when a new rectangle is selected.

Parameters:

listener - the listener to be registered

removeRectangleSelectionListener

void removeRectangleSelectionListener(RectangleSelectionListener listener)

Unregisters a rectangle selection listener.

Parameters:

listener - the listener to be unregistered

setPage

void setPage(Page page)

Sets page model from the external source

Parameters:

page -

getPage

Page getPage()

Gets the actual page model

Returns:

the actual page model

getAreaTree

AreaTree getAreaTree()

Gets the area tree of the current page

Returns:

the current area tree or null if the tree has not been built yet

getLogicalTree

LogicalAreaTree getLogicalTree()

Gets the logical area tree of the actual page

Returns:

the current logical tree or null if the tree has not been built yet

setAreaTree

void setAreaTree(AreaTree areaTree)

Sets area tree from external source

setLogicalTree

void setLogicalTree(LogicalAreaTree logicalTree)

Sets logical area tree from external source

refreshView

void refreshView()

Updates the tree views after some trees have been changed.

displayErrorMessage

void displayErrorMessage(String text)

Displays an error message dialog.

Parameters:

text - the text do be displayed

displayInfoMessage

void displayInfoMessage(String text)

Displays an info message dialog.

Parameters:

text - the text do be displayed

setSelection

void setSelection(Rectangular rect)

Graphically selects a rectangular area in the browser window.

Parameters:

rect - The size and position of the selected area.

clearSelection

void clearSelection()

Clears the graphical selection.