org.fit.layout.api

Interface AreaTreeOperator

All Superinterfaces:

ParametrizedOperation, Service

All Known Implementing Classes:

BaseOperator

public interface AreaTreeOperator
extends Service, ParametrizedOperation

A generic procedure that processes the area tree. The procedures may be applied in any order.

Author:

burgetr

Method Summary

Modifier and Type	Method and Description
void	apply(AreaTree atree) Applies the operation to the given tree.
void	apply(AreaTree atree, Area root) Applies the operation to the given subtree of the tree.
String	getCategory() Returns the operator category that allows to group similar operators in the GUI.

Methods inherited from interface org.fit.layout.api.Service

getDescription, getId, getName

Methods inherited from interface org.fit.layout.api.ParametrizedOperation

getParam, getParams, setParam

Method Detail

getCategory

String getCategory()

Returns the operator category that allows to group similar operators in the GUI.

Returns:

The category name

apply

void apply(AreaTree atree)

Applies the operation to the given tree.

Parameters:

atree - the area tree to be modified.

apply

void apply(AreaTree atree,
           Area root)

Applies the operation to the given subtree of the tree.

Parameters:

atree - the area tree to be modified.

root - the root node of the affected subtree.