org.omegahat.Graphics.Layouts
Interface RegionAllocator

All Known Subinterfaces:

EnumeratedRegionAllocator

All Known Implementing Classes:

DefaultAllocator, GridAllocator, BorderAllocator

public interface RegionAllocator

The abstract class that all Layout allocators must extend providing methods to get a RegionDescription by integer, string or general identifier and List of all of them in one call.

Method Summary

java.util.List	getRegionDescriptions(GraphicalContainerInt parent)
java.util.List	getRegions(ScaleInt sx, ScaleInt sy, int parentOrigin, double widthCM, double heightCM, double fontSize, GraphicalContainerInt parentId) Opportunity to compute and assign actual regions based on the current size of the specified parent.
RegionDescriptionInt	setDescription(int which, GraphicalComponentInt go, GraphicalContainerInt parent)
RegionDescriptionInt	setDescription(java.lang.Object id, GraphicalComponentInt go, GraphicalContainerInt parent) General indexing, such as int[] for a GridAllocator, which is supported differently by the different allocators.
RegionDescriptionInt	setDescription(java.lang.String which, GraphicalComponentInt go, GraphicalContainerInt parent)

Method Detail

getRegionDescriptions

public java.util.List getRegionDescriptions(GraphicalContainerInt parent)

setDescription

public RegionDescriptionInt setDescription(int which,
                                           GraphicalComponentInt go,
                                           GraphicalContainerInt parent)

setDescription

public RegionDescriptionInt setDescription(java.lang.String which,
                                           GraphicalComponentInt go,
                                           GraphicalContainerInt parent)

setDescription

public RegionDescriptionInt setDescription(java.lang.Object id,
                                           GraphicalComponentInt go,
                                           GraphicalContainerInt parent)
                                    throws java.lang.Exception

General indexing, such as int[] for a GridAllocator, which is supported differently by the different allocators.

getRegions

public java.util.List getRegions(ScaleInt sx,
                                 ScaleInt sy,
                                 int parentOrigin,
                                 double widthCM,
                                 double heightCM,
                                 double fontSize,
                                 GraphicalContainerInt parentId)

Opportunity to compute and assign actual regions based on the current size of the specified parent. An allocator can then distribute the resulting regions to its descriptions to avoid recomputing them for each one separately and the presence of the parent can allow the results to be stored by parent and be retrieved in the draw method