org.fit.layout.api

Interface OutputDisplay

All Known Implementing Classes:

OutputDisplayImpl

public interface OutputDisplay

An abstraction of the graphical display of the segmentation output. It allows drawing the area bounds and distinguishing the area types by colors.

Author:

burgetr

Method Summary

Methods

Modifier and Type	Method and Description
void	colorizeByClass(Area area, java.lang.String cname) Draws the colorized are bounds.
void	colorizeByTags(Area area, java.util.Set<Tag> s) Draws the colorized are bounds.
void	drawBox(Box box) Draws the box contents on the page depending on the box type.
void	drawExtent(Area area) Draws the area bounds at the output display.
void	drawExtent(Box box) Draws the box bounds at the output display.
void	drawPage(Page page) Draws the complete page including all the boxes.
void	drawRectangle(Rectangular rect, java.awt.Color color) Draws the given rectangle with the specified color.
java.awt.Graphics2D	getGraphics()

Method Detail

getGraphics

java.awt.Graphics2D getGraphics()

drawPage

void drawPage(Page page)

Draws the complete page including all the boxes.

Parameters:

page - The page to draw.

drawBox

void drawBox(Box box)

Draws the box contents on the page depending on the box type. This does not automatically draw the child boxes.

Parameters:

box - The box do draw.

drawExtent

void drawExtent(Box box)

Draws the box bounds at the output display.

Parameters:

box - The box to be displayed

drawExtent

void drawExtent(Area area)

Draws the area bounds at the output display.

Parameters:

area - The area to be displayed

drawRectangle

void drawRectangle(Rectangular rect,
                 java.awt.Color color)

Draws the given rectangle with the specified color.

Parameters:

rect - the rectangle to be drawn

color - the drawing color

colorizeByTags

void colorizeByTags(Area area,
                  java.util.Set<Tag> s)

Draws the colorized are bounds. The color is defined by the tags. Multiple colors should be used when there are multiple tags (e.g. splitting the area bounds to several parts). The output display should assign different colors to different tags; the exact implementation of the color mapping depends on the OutputDisplay implementation. The area is not displayed when the tag set is empty.

Parameters:

area - The area to be displayed

s - A set of tags used for generating the area colors

colorizeByClass

void colorizeByClass(Area area,
                   java.lang.String cname)

Draws the colorized are bounds. The color is defined by a string. The output display should assign different colors to different strings; the exact implementation of the color mapping depends on the OutputDisplay implementation. The area is not displayed when class name is empty.

Parameters:

area - The area to be displayed

cname - The class name used for generating the colors.