org.fit.layout.impl

Class DefaultArea

java.lang.Object

org.fit.layout.impl.GenericTreeNode

org.fit.layout.impl.DefaultContentRect

org.fit.layout.impl.DefaultArea

All Implemented Interfaces:

Area, AreaTreeNode<Area>, ContentRect, Rect, Taggable

Direct Known Subclasses:

AreaImpl

public class DefaultArea
extends DefaultContentRect
implements Area

Default generic Area implementation.

Author:

burgetr

Constructor Summary

Constructors

Constructor and Description
DefaultArea(Box box)
DefaultArea(DefaultArea src)
DefaultArea(int x1, int y1, int x2, int y2)
DefaultArea(java.util.List<Box> boxList)
DefaultArea(Rectangular r)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addBox(Box box) Adds a new box to the area.
void	addTag(Tag tag, float support) Adds a tag to this area.
void	appendChild(Area child) Appends a new child area to the list of child areas of this area.
void	appendChildren(java.util.List<Area> list) Appends a list of child areas to the list of child areas of this area.
boolean	containsTag(Tag tag) Tests whether the area or any of its direct child areas have the given tag.
void	createGrid() Creates the grid of areas from the child areas.
Area	createSuperArea(Rectangular gp, java.util.List<Area> selected, java.lang.String name) Creates a new subarea from a specified region of the area and moves the selected child nodes to the new area.
protected AreaTopology	createTopology() Creates a topology for this area.
java.util.Vector<Box>	getAllBoxes() Obtains all the boxes from this area and all the child areas.
java.util.Vector<Box>	getBoxes() Returns a vector of boxes that are inside of this area
java.lang.String	getBoxText() Returns the text string represented by a concatenation of all the boxes contained directly in this area (no subareas)
Rectangular	getContentBounds()
java.awt.Color	getEffectiveBackgroundColor() Obtains the effective background color visible under the area.
AreaGrid	getGrid() Obtains the gird of contained areas.
int	getGridHeight()
Rectangular	getGridPosition()
int	getGridWidth()
int	getGridX()
int	getGridY()
Area	getChildArea(int index) Obtains the n-th child area.
java.util.List<Area>	getChildAreas() Returns the list of all the child areas.
DefaultArea	getChildAtGridPos(int x, int y) Returns the child area at the specified grid position or null, if there is no child area at this position.
int	getIndex(Area child) Returns the index of the specified child in this node's child array.
Tag	getMostSupportedTag() Obtains the tag with the greatest support that is assigned to this area.
java.lang.String	getName()
Area	getNextOnLine()
Area	getNextSibling() Obtains the next siblibg of this area.
Area	getParentArea() Obtains the parent area of this area.
Area	getPreviousOnLine()
Area	getPreviousSibling() Obtains the previous siblibg of this area.
java.util.Map<Tag,java.lang.Float>	getTags() Obtains the set of tags assigned to the area.
float	getTagSupport(Tag tag) Obtains the support of the given tag assignment
java.lang.String	getText() Returns the complete text contained in this area and its sub area.
java.lang.String	getText(java.lang.String separator) Returns the complete text contained in this area and its sub area.
AreaTopology	getTopology() Returns the topology of this area.
boolean	hasTag(Tag tag) Tests whether the area has this tag.
boolean	hasTag(Tag tag, float minSupport) Tests whether the area has this tag with a support greater or equal to the specified value.
void	insertChild(Area child, int index) Inserts a new child at the given position.
boolean	isHorizontalSeparator() Checks whether the area can be interpreted as a horizontal separator.
boolean	isReplaced() Checks whether this area is formed by replaced boxes.
boolean	isSeparator() Checks whether the area can be interpreted as any kind of separator.
boolean	isVerticalSeparator() Checks whether the area can be interpreted as a vertical separator.
void	removeAllTags(java.util.Collection<Tag> c) Removes all tags that belong to the given collection.
void	removeChild(Area child) Removes a child area from its parent.
void	removeTag(Tag tag) Removes the specific tag
void	setGridPosition(Rectangular pos) Sets the position in the parent area grid for this area
void	setGridX(int gridX)
void	setGridY(int gridY)
void	SetHorizontalSeparator(boolean hsep)
void	setName(java.lang.String name) Sets the name of the area.
void	setNextOnLine(Area nextOnLine)
void	setPreviousOnLine(Area previousOnLine)
void	SetVerticalSeparator(boolean vsep)
java.lang.String	toString()

Methods inherited from class org.fit.layout.impl.DefaultContentRect

getBackgroundColor, getBorderCount, getBottomBorder, getBounds, getFontSize, getFontStyle, getFontWeight, getHeight, getId, getLeftBorder, getLineThrough, getPage, getRightBorder, getTopBorder, getUnderline, getWidth, getX1, getX2, getY1, getY2, hasBottomBorder, hasLeftBorder, hasRightBorder, hasTopBorder, isBackgroundSeparated, setBackgroundColor, setBackgroundSeparated, setBorders, setBottomBorder, setBounds, setFontSize, setFontStyle, setFontWeight, setId, setLeftBorder, setLineThrough, setPage, setRightBorder, setTopBorder, setUnderline

Methods inherited from class org.fit.layout.impl.GenericTreeNode

add, addAttribute, getAttribute, getDepth, getChildAt, getChildCount, getChildren, getIndex, getLeafCount, getNextSiblingNode, getParent, getPreviousSiblingNode, getRoot, insert, isLeaf, isRoot, remove, remove, removeAllChildren

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fit.layout.model.ContentRect

getBackgroundColor, getBorderCount, getBottomBorder, getBounds, getFontSize, getFontStyle, getFontWeight, getId, getLeftBorder, getLineThrough, getPage, getRightBorder, getTopBorder, getUnderline, hasBottomBorder, hasLeftBorder, hasRightBorder, hasTopBorder, isBackgroundSeparated

Methods inherited from interface org.fit.layout.model.Rect

getHeight, getWidth, getX1, getX2, getY1, getY2

Methods inherited from interface org.fit.layout.model.AreaTreeNode

addAttribute, getAttribute, getDepth, getChildCount, getLeafCount, isLeaf, removeAllChildren

Constructor Detail

DefaultArea

public DefaultArea(Rectangular r)

DefaultArea

public DefaultArea(DefaultArea src)

DefaultArea

public DefaultArea(int x1,
           int y1,
           int x2,
           int y2)

DefaultArea

public DefaultArea(Box box)

DefaultArea

public DefaultArea(java.util.List<Box> boxList)

Method Detail

setName

public void setName(java.lang.String name)

Sets the name of the area. The name is used when the area information is displayed using toString()

Parameters:

name - The new area name

getName

public java.lang.String getName()

getContentBounds

public Rectangular getContentBounds()

getTopology

public AreaTopology getTopology()

Description copied from interface: Area

Returns the topology of this area.

Specified by:

getTopology in interface Area

Returns:

The area topology.

createTopology

protected AreaTopology createTopology()

Creates a topology for this area. This method should be overriden when another topology implementation is used. By default, it returns the default grid-based topology.

Returns:

The created topology for this area

getEffectiveBackgroundColor

public java.awt.Color getEffectiveBackgroundColor()

Description copied from interface: Area

Obtains the effective background color visible under the area.

Specified by:

getEffectiveBackgroundColor in interface Area

Returns:

The background color.

getParentArea

public Area getParentArea()

Description copied from interface: AreaTreeNode

Obtains the parent area of this area.

Specified by:

getParentArea in interface AreaTreeNode<Area>

Returns:

The parent area or null when this is the root area.

getPreviousSibling

public Area getPreviousSibling()

Description copied from interface: AreaTreeNode

Obtains the previous siblibg of this area.

Specified by:

getPreviousSibling in interface AreaTreeNode<Area>

Returns:

The previous siblibg area or null when this is the first child.

getNextSibling

public Area getNextSibling()

Description copied from interface: AreaTreeNode

Obtains the next siblibg of this area.

Specified by:

getNextSibling in interface AreaTreeNode<Area>

Returns:

The next siblibg area or null when this is the last child.

getChildArea

public Area getChildArea(int index)
                  throws java.lang.ArrayIndexOutOfBoundsException

Description copied from interface: AreaTreeNode

Obtains the n-th child area.

Specified by:

getChildArea in interface AreaTreeNode<Area>

Parameters:

index - the child index

Returns:

the child area at the given index

Throws:

java.lang.ArrayIndexOutOfBoundsException

getChildAreas

public java.util.List<Area> getChildAreas()

Description copied from interface: AreaTreeNode

Returns the list of all the child areas.

Specified by:

getChildAreas in interface AreaTreeNode<Area>

Returns:

a list containing all the child areas.

getIndex

public int getIndex(Area child)

Description copied from interface: AreaTreeNode

Returns the index of the specified child in this node's child array. If the specified node is not a child of this node, returns -1.

Specified by:

getIndex in interface AreaTreeNode<Area>

Parameters:

child - the child node to search

Returns:

the child index or -1 if not a child

appendChild

public void appendChild(Area child)

Description copied from interface: AreaTreeNode

Appends a new child area to the list of child areas of this area.

Specified by:

appendChild in interface AreaTreeNode<Area>

Parameters:

child - The new child to be appended

appendChildren

public void appendChildren(java.util.List<Area> list)

Description copied from interface: AreaTreeNode

Appends a list of child areas to the list of child areas of this area.

Specified by:

appendChildren in interface AreaTreeNode<Area>

Parameters:

list - The list of new children to be appended

insertChild

public void insertChild(Area child,
               int index)

Description copied from interface: AreaTreeNode

Inserts a new child at the given position.

Specified by:

insertChild in interface AreaTreeNode<Area>

Parameters:

child - the child to be inserted

index - the index of the new child

removeChild

public void removeChild(Area child)

Description copied from interface: AreaTreeNode

Removes a child area from its parent.

Specified by:

removeChild in interface AreaTreeNode<Area>

Parameters:

child - The new child to be appended

getPreviousOnLine

public Area getPreviousOnLine()

setPreviousOnLine

public void setPreviousOnLine(Area previousOnLine)

getNextOnLine

public Area getNextOnLine()

setNextOnLine

public void setNextOnLine(Area nextOnLine)

getText

public java.lang.String getText()

Description copied from interface: Area

Returns the complete text contained in this area and its sub area.

Specified by:

getText in interface Area

Returns:

A text string (possibly empty)

getText

public java.lang.String getText(java.lang.String separator)

Description copied from interface: Area

Returns the complete text contained in this area and its sub area. The individual areas are separated by the given string separator.

Specified by:

getText in interface Area

Parameters:

separator - the string separating the individual areas

Returns:

A text string (possibly empty)

isReplaced

public boolean isReplaced()

Description copied from interface: Area

Checks whether this area is formed by replaced boxes.

Specified by:

isReplaced in interface Area

Returns:

true if the area contains replaced boxes only

addBox

protected void addBox(Box box)

Adds a new box to the area.

Parameters:

box -

getBoxes

public java.util.Vector<Box> getBoxes()

Returns a vector of boxes that are inside of this area

Specified by:

getBoxes in interface Area

Returns:

A vector containing the Box objects

getAllBoxes

public java.util.Vector<Box> getAllBoxes()

Obtains all the boxes from this area and all the child areas.

Specified by:

getAllBoxes in interface Area

Returns:

The list of boxes

getBoxText

public java.lang.String getBoxText()

Returns the text string represented by a concatenation of all the boxes contained directly in this area (no subareas)

createGrid

public void createGrid()

Creates the grid of areas from the child areas.

getGrid

public AreaGrid getGrid()

Obtains the gird of contained areas.

Returns:

the grid

getGridHeight

public int getGridHeight()

Returns:

Returns the height of the area in the grid height in rows

getGridWidth

public int getGridWidth()

Returns:

Returns the width of the area in the grid in rows

getGridX

public int getGridX()

Returns:

Returns the gridX.

setGridX

public void setGridX(int gridX)

Parameters:

gridX - The gridX to set.

getGridY

public int getGridY()

Returns:

Returns the gridY.

setGridY

public void setGridY(int gridY)

Parameters:

gridY - The gridY to set.

getGridPosition

public Rectangular getGridPosition()

Returns:

the position of this area in the grid of its parent area

setGridPosition

public void setGridPosition(Rectangular pos)

Sets the position in the parent area grid for this area

Parameters:

pos - the position

getChildAtGridPos

public DefaultArea getChildAtGridPos(int x,
                            int y)

Returns the child area at the specified grid position or null, if there is no child area at this position.

addTag

public void addTag(Tag tag,
          float support)

Description copied from interface: Taggable

Adds a tag to this area. If the tag is already assigned to the area, the greater of the original and new support will be used.

Specified by:

addTag in interface Taggable

Parameters:

tag - The tag to be added.

support - The assigned tag support from 0.0 to 1.0

hasTag

public boolean hasTag(Tag tag)

Description copied from interface: Taggable

Tests whether the area has this tag.

Specified by:

hasTag in interface Taggable

Parameters:

tag - the tag to be tested.

Returns:

true if the area has this tag

hasTag

public boolean hasTag(Tag tag,
             float minSupport)

Description copied from interface: Taggable

Tests whether the area has this tag with a support greater or equal to the specified value.

Specified by:

hasTag in interface Taggable

Parameters:

tag - the tag to be tested

minSupport - minimal required support

Returns:

true if the area has this tag

getTagSupport

public float getTagSupport(Tag tag)

Description copied from interface: Taggable

Obtains the support of the given tag assignment

Specified by:

getTagSupport in interface Taggable

Parameters:

tag - The tag to be tested

Returns:

The support of the given tag in the range 0.0 to 1.0. Returns 0.0 when the tag is not assigned to this area.

getMostSupportedTag

public Tag getMostSupportedTag()

Description copied from interface: Taggable

Obtains the tag with the greatest support that is assigned to this area.

Specified by:

getMostSupportedTag in interface Taggable

Returns:

The tag with the greatest support or null if there are no tags assigned to this area

removeAllTags

public void removeAllTags(java.util.Collection<Tag> c)

Removes all tags that belong to the given collection.

Parameters:

c - A collection of tags to be removed.

removeTag

public void removeTag(Tag tag)

Removes the specific tag

Specified by:

removeTag in interface Taggable

Parameters:

tag -

containsTag

public boolean containsTag(Tag tag)

Tests whether the area or any of its direct child areas have the given tag.

Parameters:

tag - the tag to be tested.

Returns:

true if the area or its direct child areas have the given tag

getTags

public java.util.Map<Tag,java.lang.Float> getTags()

Obtains the set of tags assigned to the area.

Specified by:

getTags in interface Taggable

Returns:

a set of tags

SetHorizontalSeparator

public void SetHorizontalSeparator(boolean hsep)

isHorizontalSeparator

public boolean isHorizontalSeparator()

Description copied from interface: Area

Checks whether the area can be interpreted as a horizontal separator.

Specified by:

isHorizontalSeparator in interface Area

Returns:

true when this area is a horizontal separator

SetVerticalSeparator

public void SetVerticalSeparator(boolean vsep)

isVerticalSeparator

public boolean isVerticalSeparator()

Description copied from interface: Area

Checks whether the area can be interpreted as a vertical separator.

Specified by:

isVerticalSeparator in interface Area

Returns:

true when this area is a vertical separator

isSeparator

public boolean isSeparator()

Description copied from interface: Area

Checks whether the area can be interpreted as any kind of separator.

Specified by:

isSeparator in interface Area

Returns:

true when this area is a separator

createSuperArea

public Area createSuperArea(Rectangular gp,
                   java.util.List<Area> selected,
                   java.lang.String name)

Description copied from interface: Area

Creates a new subarea from a specified region of the area and moves the selected child nodes to the new area.

Specified by:

createSuperArea in interface Area

Parameters:

gp - the subarea bounds

selected - nodes to be moved to the new area

name - the name (identification) of the new area

Returns:

the new AreaNode created in the tree or null, if nothing was created

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object