com.itmill.toolkit.ui
Class GridLayout

java.lang.Object
  com.itmill.toolkit.terminal.Identifiable
      com.itmill.toolkit.ui.AbstractComponent
          com.itmill.toolkit.ui.AbstractComponentContainer
              com.itmill.toolkit.ui.GridLayout

All Implemented Interfaces:

MethodEventSource, Paintable, VariableOwner, Component, ComponentContainer, Layout, EventListener

public class GridLayout
extends AbstractComponentContainer
implements Layout

A container that consists of components with certain coordinates on a grid. It also maintains cursor for adding component in left to right, top to bottom order.

Each component in a GridLayout uses a certain area (x1,y1,x2,y2) from the grid. One should not add components that would overlap with the existing components because in such case an GridLayout.OverlapsException is thrown. Adding component with cursor automatically extends the grid by increasing the grid height.

Since:

3.0

Version:

4.1.4

Author:

IT Mill Ltd.

Nested Class Summary

class	GridLayout.Area This class defines an area on a grid.
class	GridLayout.OutOfBoundsException An Exception object which is thrown when an area exceeds the bounds of the grid.
class	GridLayout.OverlapsException An Exception object which is thrown when two Items occupy the same space on a grid.

Nested classes/interfaces inherited from interface com.itmill.toolkit.ui.ComponentContainer

ComponentContainer.ComponentAttachEvent, ComponentContainer.ComponentAttachListener, ComponentContainer.ComponentDetachEvent, ComponentContainer.ComponentDetachListener

Nested classes/interfaces inherited from interface com.itmill.toolkit.ui.Component

Component.ErrorEvent, Component.ErrorListener, Component.Event, Component.Focusable, Component.Listener

Nested classes/interfaces inherited from interface com.itmill.toolkit.terminal.Paintable

Paintable.RepaintRequestEvent, Paintable.RepaintRequestListener

Constructor Summary

GridLayout()
Constructs an empty grid layout that is extended as needed.

GridLayout(int width, int height)
Constructor for grid of given size.

Method Summary

void	addComponent(Component component) Adds the component into this container to the cursor position.
void	addComponent(Component c, int x, int y) Adds the component into this container to coordinates x1,y1 (NortWest corner of the area.)
void	addComponent(Component component, int x1, int y1, int x2, int y2) Adds a component with a specified area to the grid.
Iterator	getComponentIterator() Gets an Iterator to the component container contents.
int	getCursorX() Gets the current cursor x-position.
int	getCursorY() Gets the current cursor y-position.
int	getHeight() Gets the height of the grid.
String	getTag() Gets the components UIDL tag.
int	getWidth() Get the width of the grids.
void	newLine() Force the next component to be added to the beginning of the next line.
void	paintContent(PaintTarget target) Paints the contents of this component.
void	removeAllComponents() Removes all components from the container.
void	removeComponent(Component component) Removes the given component from this container.
void	removeComponent(int x, int y) Removes the component specified with it's top-left corner coordinates from this grid.
void	replaceComponent(Component oldComponent, Component newComponent) Replaces the component in the container with another one without changing position.
void	setHeight(int height) Sets the height of the grid.
void	setWidth(int width) Sets the width of the grid.
void	space() Moves the cursor forwards by one.

Methods inherited from class com.itmill.toolkit.ui.AbstractComponentContainer

addListener, addListener, attach, detach, fireComponentAttachEvent, fireComponentDetachEvent, moveComponentsFrom, removeListener, removeListener

Methods inherited from class com.itmill.toolkit.ui.AbstractComponent

addListener, addListener, addListener, addListener, changeVariables, childRequestedRepaint, dependsOn, fireComponentErrorEvent, fireComponentEvent, fireEvent, getApplication, getCaption, getComponentError, getData, getDescription, getDirectDependencies, getErrorMessage, getIcon, getLocale, getParent, getStyle, getWindow, isEnabled, isImmediate, isReadOnly, isVisible, paint, removeDirectDependency, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintRequests, setCaption, setComponentError, setData, setDescription, setEnabled, setIcon, setImmediate, setLocale, setParent, setReadOnly, setStyle, setVisible

Methods inherited from class com.itmill.toolkit.terminal.Identifiable

getDebugId, getUIID, setDebugId, setUIID

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.itmill.toolkit.ui.ComponentContainer

addListener, addListener, moveComponentsFrom, removeListener, removeListener

Methods inherited from interface com.itmill.toolkit.ui.Component

addListener, attach, childRequestedRepaint, detach, getApplication, getCaption, getIcon, getLocale, getParent, getStyle, getWindow, isEnabled, isReadOnly, isVisible, removeListener, setEnabled, setParent, setReadOnly, setStyle, setVisible

Methods inherited from interface com.itmill.toolkit.terminal.Paintable

addListener, paint, removeListener, requestRepaint, requestRepaintRequests

Methods inherited from interface com.itmill.toolkit.terminal.VariableOwner

changeVariables, dependsOn, getDirectDependencies, isImmediate, removeDirectDependency

Constructor Detail

GridLayout

public GridLayout(int width,
                  int height)

Constructor for grid of given size. Note that grid's final size depends on the items that are added into the grid. Grid grows if you add components outside the grid's area.

Parameters:

width - the Width of the grid.

height - the Height of the grid.

GridLayout

public GridLayout()

Constructs an empty grid layout that is extended as needed.

Method Detail

addComponent

public void addComponent(Component component,
                         int x1,
                         int y1,
                         int x2,
                         int y2)
                  throws GridLayout.OverlapsException,
                         GridLayout.OutOfBoundsException

Adds a component with a specified area to the grid. The area the new component should take is defined by specifying the upper left corner (x1, y1) and the lower right corner (x2, y2) of the area.

If the new component overlaps with any of the existing components already present in the grid the operation will fail and an GridLayout.OverlapsException is thrown.

Parameters:

c - the component to be added.

x1 - the X-coordinate of the upper left corner of the area c is supposed to occupy.

y1 - the Y-coordinate of the upper left corner of the area c is supposed to occupy.

x2 - the X-coordinate of the lower right corner of the area c is supposed to occupy.

y2 - the Y-coordinate of the lower right corner of the area c is supposed to occupy.

Throws:

GridLayout.OverlapsException - if the new component overlaps with any of the components already in the grid.

GridLayout.OutOfBoundsException - if the coordinates are outside of the grid area.

addComponent

public void addComponent(Component c,
                         int x,
                         int y)

Adds the component into this container to coordinates x1,y1 (NortWest corner of the area.) End coordinates (SouthEast corner of the area) are the same as x1,y1. Component width and height is 1.

Parameters:

c - the component to be added.

x - the X-coordinate.

y - the Y-coordinate.

newLine

public void newLine()

Force the next component to be added to the beginning of the next line. By calling this function user can ensure that no more components are added to the right of the previous component.

See Also:

space()

space

public void space()

Moves the cursor forwards by one. If the cursor goes out of the right grid border, move it to next line.

See Also:

newLine()

addComponent

public void addComponent(Component component)

Adds the component into this container to the cursor position. If the cursor position is already occupied, the cursor is moved forwards to find free position. If the cursor goes out from the bottom of the grid, the grid is automaticly extended.

Specified by:

addComponent in interface ComponentContainer

Overrides:

addComponent in class AbstractComponentContainer

Parameters:

c - the component to be added.

See Also:

ComponentContainer.addComponent(Component)

removeComponent

public void removeComponent(Component component)

Removes the given component from this container.

Specified by:

removeComponent in interface ComponentContainer

Overrides:

removeComponent in class AbstractComponentContainer

Parameters:

c - the component to be removed.

See Also:

ComponentContainer.removeComponent(Component)

removeComponent

public void removeComponent(int x,
                            int y)

Removes the component specified with it's top-left corner coordinates from this grid.

Parameters:

x - the Component's top-left corner's X-coordinate.

y - the Component's top-left corner's Y-coordinate.

getComponentIterator

public Iterator getComponentIterator()

Gets an Iterator to the component container contents. Using the Iterator it's possible to step through the contents of the container.

Specified by:

getComponentIterator in interface ComponentContainer

Returns:

the Iterator of the components inside the container.

paintContent

public void paintContent(PaintTarget target)
                  throws PaintException

Paints the contents of this component.

Overrides:

paintContent in class AbstractComponent

Parameters:

target - the Paint Event.

Throws:

PaintException - if the paint operation failed.

getTag

public String getTag()

Gets the components UIDL tag.

Specified by:

getTag in class AbstractComponent

Returns:

the Component UIDL tag as string.

See Also:

AbstractComponent.getTag()

setWidth

public void setWidth(int width)

Sets the width of the grid. The width can not be reduced if there are any areas that would be outside of the shrunk grid.

Parameters:

width - the New width of the grid.

getWidth

public final int getWidth()

Get the width of the grids.

Returns:

the width of the grid.

setHeight

public void setHeight(int height)

Sets the height of the grid. The width can not be reduced if there are any areas that would be outside of the shrunk grid.

Parameters:

height - the height of the grid.

getHeight

public final int getHeight()

Gets the height of the grid.

Returns:

int - how many cells high the grid is.

getCursorX

public int getCursorX()

Gets the current cursor x-position. The cursor position points the position for the next component that is added without specifying its coordinates. When the cursor position is occupied, the next component will be added to first free position after the cursor.

Returns:

the Cursor x-coordinate.

getCursorY

public int getCursorY()

Gets the current cursor y-position. The cursor position points the position for the next component that is added without specifying its coordinates. When the cursor position is occupied, the next component will be added to first free position after the cursor.

Returns:

the Cursor y-coordinate.

replaceComponent

public void replaceComponent(Component oldComponent,
                             Component newComponent)

Description copied from interface: ComponentContainer

Replaces the component in the container with another one without changing position.

This method replaces component with another one is such way that the new component overtakes the position of the old component. If the old component is not in the container, the new component is added to the container. If the both component are already in the container, their positions are swapped. Component attach and detach events should be taken care as with add and remove.

Specified by:

replaceComponent in interface ComponentContainer

Parameters:

oldComponent - the old component that will be replaced.

newComponent - the new component to be replaced.

removeAllComponents

public void removeAllComponents()

Description copied from class: AbstractComponentContainer

Removes all components from the container. This should probably be reimplemented in extending classes for a more powerfull implementation.

Specified by:

removeAllComponents in interface ComponentContainer

Overrides:

removeAllComponents in class AbstractComponentContainer