| java.lang.Object
 org.millstone.base.ui.AbstractComponent
org.millstone.base.ui.AbstractComponentContainer
org.millstone.base.ui.GridLayout
| GridLayout | | public class GridLayout extends AbstractComponentContainer implements Layout(Code) | | 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
GridLayout.Area 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
OverlapsException is thrown. Adding component with
cursor automatically extends the grid by increasing the grid height.
author:
IT Mill Ltd.
version:
3.1.1
since:
3.0 |
| Inner Class :public class Area | |
| Constructor Summary | |
| public | GridLayout(int width, int height)
Constructor for grid of given size. | | public | GridLayout()
Constructs an empty grid layout that is extended as needed. |
| Method Summary | |
| public void | addComponent(Component component, int x1, int y1, int x2, int y2)
Adds a component with a specified area to the grid. | | public void | addComponent(Component c, int x, int y)
Add 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. | | public void | addComponent(Component component)
Add a component into this container to the cursor position.
If the cursor position is already occupied, the cursor is
moved forwards to find free position. | | public Iterator | getComponentIterator()
Gets an Iterator to the component container contents. | | public int | getCursorX()
Get the current cursor x-position.
The cursor position points the position for the next component
that is added without specifying its coordinates. | | public int | getCursorY()
Get the current cursor y-position.
The cursor position points the position for the next component
that is added without specifying its coordinates. | | final public int | getHeight()
Get the height of the grid. | | public String | getTag()
Gets the components UIDL tag. | | final public int | getWidth()
Get the width of the grids. | | public void | newLine()
Force the next component to be added to the beginning of the next line. | | public void | paintContent(PaintTarget target)
Paints the contents of this component. | | public void | removeAllComponents()
| | public void | removeComponent(Component component)
Removes the given component from this
container. | | public void | removeComponent(int x, int y)
Removes a component specified with it's top-left corner coordinates
from this grid. | | public void | replaceComponent(Component oldComponent, Component newComponent)
| | public void | setHeight(int height)
Set the height of the grid. | | public void | setWidth(int width)
Set the width of the grid. | | public void | space()
Move cursor forwards by one. |
| GridLayout | | public GridLayout(int width, int height)(Code) | | 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 - Width of the grid.
Parameters:
height - Height of the grid. |
| GridLayout | | public GridLayout()(Code) | | Constructs an empty grid layout that is extended as needed.
|
| addComponent | | public void addComponent(Component component, int x1, int y1, int x2, int y2) throws OverlapsException, OutOfBoundsException(Code) | | 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
OverlapsException is thrown.
Parameters:
c - The component to be added.
Parameters:
x1 - The X-coordinate of the upper left corner of the areac is supposed to occupy
Parameters:
y1 - The Y-coordinate of the upper left corner of the areac is supposed to occupy
Parameters:
x2 - The X-coordinate of the lower right corner of the areac is supposed to occupy
Parameters:
y2 - The Y-coordinate of the lower right corner of the areac is supposed to occupy
throws:
OverlapsException - if the new component overlaps with anyof the components already in the grid
throws:
OutOfBoundsException - if the coordinates are outside of thegrid area. |
| addComponent | | public void addComponent(Component c, int x, int y)(Code) | | Add 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.
Parameters:
x - X-coordinate
Parameters:
y - Y-coordinate |
| addComponent | | public void addComponent(Component component)(Code) | | Add a 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.
Parameters:
c - The component to be added. |
| getComponentIterator | | public Iterator getComponentIterator()(Code) | | Gets an Iterator to the component container contents. Using the
Iterator it's possible to step through the contents of the container.
Iterator of the components inside the container. |
| getCursorX | | public int getCursorX()(Code) | | Get 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.
Cursor x-coordinate. |
| getCursorY | | public int getCursorY()(Code) | | Get 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.
Cursor y-coordinate. |
| getHeight | | final public int getHeight()(Code) | | Get the height of the grid.
int - how many cells high the grid is |
| getWidth | | final public int getWidth()(Code) | | Get the width of the grids.
The width of the grid |
| newLine | | public void newLine()(Code) | | 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: GridLayout.space() |
| removeAllComponents | | public void removeAllComponents()(Code) | | |
| removeComponent | | public void removeComponent(Component component)(Code) | | Removes the given component from this
container.
Parameters:
c - The component to be removed. |
| removeComponent | | public void removeComponent(int x, int y)(Code) | | Removes a component specified with it's top-left corner coordinates
from this grid.
Parameters:
x - Component's top-left corner's X-coordinate
Parameters:
y - Component's top-left corner's Y-coordinate |
| setHeight | | public void setHeight(int height)(Code) | | Set 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 - of the grid |
| setWidth | | public void setWidth(int width)(Code) | | Set 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 - New width of the grid.
throws:
OutOfBoundsException - if the one of the areas would exceed thebounds of the grid after the modification of the grid size. |
| space | | public void space()(Code) | | Move cursor forwards by one. If the cursor goes out of the right grid border,
move it to next line.
See Also: GridLayout.newLine() |
| Methods inherited from org.millstone.base.ui.AbstractComponent | public void addListener(RepaintRequestListener listener)(Code)(Java Doc)
public void addListener(Class eventType, Object object, Method method)(Code)(Java Doc)
public void addListener(Class eventType, Object object, String methodName)(Code)(Java Doc)
public void addListener(Component.Listener listener)(Code)(Java Doc)
public void attach()(Code)(Java Doc)
public void changeVariables(Object source, Map variables)(Code)(Java Doc)
public void childRequestedRepaint(Collection alreadyNotified)(Code)(Java Doc)
public void dependsOn(VariableOwner depended)(Code)(Java Doc)
public void detach()(Code)(Java Doc)
protected void fireComponentErrorEvent()(Code)(Java Doc)
protected void fireComponentEvent()(Code)(Java Doc)
protected void fireEvent(Component.Event event)(Code)(Java Doc)
public Application getApplication()(Code)(Java Doc)
public String getCaption()(Code)(Java Doc)
public ErrorMessage getComponentError()(Code)(Java Doc)
public Object getData()(Code)(Java Doc)
public String getDescription()(Code)(Java Doc)
public Set getDirectDependencies()(Code)(Java Doc)
public ErrorMessage getErrorMessage()(Code)(Java Doc)
public Resource getIcon()(Code)(Java Doc)
public Locale getLocale()(Code)(Java Doc)
public Component getParent()(Code)(Java Doc)
public String getStyle()(Code)(Java Doc)
abstract public String getTag()(Code)(Java Doc)
public Window getWindow()(Code)(Java Doc)
public boolean isEnabled()(Code)(Java Doc)
public boolean isImmediate()(Code)(Java Doc)
public boolean isReadOnly()(Code)(Java Doc)
public boolean isVisible()(Code)(Java Doc)
final public void paint(PaintTarget target) throws PaintException(Code)(Java Doc)
public void paintContent(PaintTarget target) throws PaintException(Code)(Java Doc)
public void removeDirectDependency(VariableOwner depended)(Code)(Java Doc)
public void removeListener(RepaintRequestListener listener)(Code)(Java Doc)
public void removeListener(Class eventType, Object target)(Code)(Java Doc)
public void removeListener(Class eventType, Object target, Method method)(Code)(Java Doc)
public void removeListener(Class eventType, Object target, String methodName)(Code)(Java Doc)
public void removeListener(Component.Listener listener)(Code)(Java Doc)
public void requestRepaint()(Code)(Java Doc)
public void requestRepaintRequests()(Code)(Java Doc)
public void setCaption(String caption)(Code)(Java Doc)
public void setComponentError(ErrorMessage componentError)(Code)(Java Doc)
public void setData(Object data)(Code)(Java Doc)
public void setDescription(String description)(Code)(Java Doc)
public void setEnabled(boolean enabled)(Code)(Java Doc)
public void setIcon(Resource icon)(Code)(Java Doc)
public void setImmediate(boolean immediate)(Code)(Java Doc)
public void setLocale(Locale locale)(Code)(Java Doc)
public void setParent(Component parent)(Code)(Java Doc)
public void setReadOnly(boolean readOnly)(Code)(Java Doc)
public void setStyle(String style)(Code)(Java Doc)
public void setVisible(boolean visible)(Code)(Java Doc)
|
|
|