org.fit.layout.gui

Interface Browser

All Known Implementing Classes:

BlockBrowser

public interface Browser

A GUI browser interface used for creating browser plugins.

Author:

burgetr

Method Summary

Methods

Modifier and Type	Method and Description
void	addAreaSelectionListener(AreaSelectionListener listener) Registers an area selection listener that is called when the area selection changes.
void	addInfoPanel(javax.swing.JComponent component, double weighty) Adds a new panel to the details area.
void	addStructurePanel(java.lang.String title, javax.swing.JComponent component) Adds a new tab to the structure view tabs.
void	addToolBar(javax.swing.JToolBar toolbar) Adds a toolbar to the browser's toolbar area.
void	addToolPanel(java.lang.String title, javax.swing.JComponent component) Adds a new tab to the tool panel at the top of the window
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	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	updateDisplay() Performs the output display refresh (when something has been painted).

Method Detail

addToolBar

void addToolBar(javax.swing.JToolBar toolbar)

Adds a toolbar to the browser's toolbar area.

Parameters:

toolbar - the toolbar to be added

addToolPanel

void addToolPanel(java.lang.String title,
                javax.swing.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(java.lang.String title,
                     javax.swing.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(javax.swing.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).

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 called when the area selection changes.

Parameters:

listener - the listener to be registered

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