CustomLayout (IT Mill Toolkit)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.itmill.toolkit.ui
Class CustomLayout

java.lang.Object
  com.itmill.toolkit.ui.AbstractComponent
      com.itmill.toolkit.ui.AbstractComponentContainer
          com.itmill.toolkit.ui.AbstractLayout
              com.itmill.toolkit.ui.CustomLayout

All Implemented Interfaces:: MethodEventSource, Paintable, Sizeable, VariableOwner, Component, ComponentContainer, Layout, EventListener

public class CustomLayout
extends AbstractLayout
extends AbstractLayout

A container component with freely designed layout and style. The container consists of items with textually represented locations. Each item contains one sub-component. The adapter and theme are responsible for rendering the layout with given style by placing the items on the screen in defined locations.

The definition of locations is not fixed - the each style can define its locations in a way that is suitable for it. One typical example would be to create visual design for a web site as a custom layout: the visual design could define locations for "menu", "body" and "title" for example. The layout would then be implemented as XLS-template with for given style.

The default theme handles the styles that are not defined by just drawing the subcomponents as in OrderedLayout.

Since:: 3.0
Version:: 5.2.12
Author:: IT Mill Ltd.

Nested Class Summary

Nested classes/interfaces inherited from class com.itmill.toolkit.ui.AbstractComponent
`AbstractComponent.ComponentErrorEvent, AbstractComponent.ComponentErrorHandler`

Nested classes/interfaces inherited from interface com.itmill.toolkit.ui.Layout
`Layout.AlignmentHandler, Layout.SpacingHandler`

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`

Field Summary

Fields inherited from class com.itmill.toolkit.ui.AbstractLayout
`margins`

Fields inherited from interface com.itmill.toolkit.terminal.Sizeable
`SIZE_UNDEFINED, UNIT_SYMBOLS, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS, UNITS_ROWS`

Constructor Summary
`CustomLayout(InputStream templateStream)` Constructs a custom layout with the template given in the stream.
`CustomLayout(String template)` Constructor for custom layout with given template name.

Method Summary
`void`	`addComponent(Component c)` Adds the component into this container.
`void`	`addComponent(Component c, String location)` Adds the component into this container to given location.
`Component`	`getComponent(String location)` Gets the child-component by its location.
`Iterator`	`getComponentIterator()` Gets the component container iterator for going trough all the components in the container.
`String`	`getTag()` Gets the component UIDL tag.
`String`	`getTemplateName()` Get the name of the template
`void`	`paintContent(PaintTarget target)` Paints the content of this component.
`void`	`removeComponent(Component c)` Removes the component from this container.
`void`	`removeComponent(String location)` Removes the component from this container from given location.
`void`	`replaceComponent(Component oldComponent, Component newComponent)` Replaces the component in the container with another one without changing position.
`void`	`setMargin(boolean enabled)` Although most layouts support margins, CustomLayout does not.
`void`	`setMargin(boolean topEnabled, boolean rightEnabled, boolean bottomEnabled, boolean leftEnabled)` Although most layouts support margins, CustomLayout does not.
`void`	`setStyle(String name)` CustomLayout's template selecting was previously implemented with setStyle.
`void`	`setTemplateName(String templateName)` Set the name of the template used to draw custom layout.

Methods inherited from class com.itmill.toolkit.ui.AbstractComponentContainer
`addListener, addListener, attach, detach, fireComponentAttachEvent, fireComponentDetachEvent, moveComponentsFrom, removeAllComponents, removeListener, removeListener, requestRepaintAll, setEnabled`

Methods inherited from class com.itmill.toolkit.ui.AbstractComponent
addListener, addListener, addListener, addListener, addStyleName, changeVariables, childRequestedRepaint, fireComponentErrorEvent, fireComponentEvent, fireEvent, getApplication, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorHandler, getErrorMessage, getHeight, getHeightUnits, getIcon, getLocale, getParent, getStyle, getStyleName, getWidth, getWidthUnits, getWindow, handleError, isEnabled, isImmediate, isReadOnly, isVisible, paint, removeListener, removeListener, removeListener, removeListener, removeListener, removeStyleName, requestRepaint, requestRepaintRequests, setCaption, setComponentError, setData, setDebugId, setDescription, setErrorHandler, setHeight, setHeight, setHeight, setHeightUnits, setIcon, setImmediate, setLocale, setParent, setReadOnly, setSizeFull, setSizeUndefined, setStyleName, setWidth, setWidth, setWidth, setWidthUnits, setVisible

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

addListener, addListener, addListener, addListener, addStyleName, changeVariables, childRequestedRepaint, fireComponentErrorEvent, fireComponentEvent, fireEvent, getApplication, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorHandler, getErrorMessage, getHeight, getHeightUnits, getIcon, getLocale, getParent, getStyle, getStyleName, getWidth, getWidthUnits, getWindow, handleError, isEnabled, isImmediate, isReadOnly, isVisible, paint, removeListener, removeListener, removeListener, removeListener, removeListener, removeStyleName, requestRepaint, requestRepaintRequests, setCaption, setComponentError, setData, setDebugId, setDescription, setErrorHandler, setHeight, setHeight, setHeight, setHeightUnits, setIcon, setImmediate, setLocale, setParent, setReadOnly, setSizeFull, setSizeUndefined, setStyleName, setWidth, setWidth, setWidth, setWidthUnits, setVisible

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, removeAllComponents, removeListener, removeListener, requestRepaintAll`

Methods inherited from interface com.itmill.toolkit.ui.Component
`addListener, addStyleName, attach, childRequestedRepaint, detach, getApplication, getCaption, getIcon, getLocale, getParent, getStyleName, getWindow, isEnabled, isReadOnly, isVisible, removeListener, removeStyleName, setCaption, setEnabled, setIcon, setParent, setReadOnly, setStyleName, setVisible`

Methods inherited from interface com.itmill.toolkit.terminal.Paintable
`addListener, getDebugId, paint, removeListener, requestRepaint, requestRepaintRequests, setDebugId`

Methods inherited from interface com.itmill.toolkit.terminal.VariableOwner
`changeVariables, isImmediate`

Methods inherited from interface com.itmill.toolkit.terminal.Sizeable
`getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightUnits, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUnits`

Constructor Detail

CustomLayout

public CustomLayout(InputStream templateStream)
             throws IOException

Constructs a custom layout with the template given in the stream.

Parameters:: templateStream - Stream containing template data. Must be using UTF-8 encoding. To use a String as a template use for instance new ByteArrayInputStream("; streamLength - Length of the templateStream
Throws:: IOException

CustomLayout

public CustomLayout(String template)

Constructor for custom layout with given template name. Template file is fetched from "/layout/".

Method Detail

getTag

public String getTag()

Gets the component UIDL tag.

Specified by:
getTag in class AbstractLayout

Returns:
the Component UIDL tag as string.

addComponent

public void addComponent(Component c, String location)

Adds the component into this container to given location.

Parameters:
c - the component to be added.
location - the location of the component.

addComponent

public void addComponent(Component c)

Adds the component into this container. The component is added without specifying the location (empty string is then used as location). Only one component can be added to the default "" location and adding more components into that location overwrites the old components.

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 c)

Removes the 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(String location)

Removes the component from this container from given location.

Parameters:
location - the Location identifier of the component.

getComponentIterator

public Iterator getComponentIterator()

Gets the component container iterator for going trough all the components in the container.

Returns:
the Iterator of the components inside the container.

getComponent

public Component getComponent(String location)

Gets the child-component by its location.

Parameters:
location - the name of the location where the requested component resides.
Returns:
the Component in the given location or null if not found.

paintContent

public void paintContent(PaintTarget target) throws PaintException

Paints the content of this component.

Overrides:
paintContent in class AbstractLayout

Parameters:
target -
Throws:
PaintException - if the paint operation failed.

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.

Parameters:
oldComponent - the old component that will be replaced.
newComponent - the new component to be replaced.

setStyle

public void setStyle(String name)

CustomLayout's template selecting was previously implemented with setStyle. Overriding to improve backwards compatibility.

Overrides:
setStyle in class AbstractComponent

Parameters:
name - template name

getTemplateName

public String getTemplateName()

Get the name of the template

setTemplateName

public void setTemplateName(String templateName)

Set the name of the template used to draw custom layout. With GWT-adapter, the template with name 'templatename' is loaded from ITMILL/themes/themename/layouts/templatename.html. If the theme has not been set (with Application.setTheme()), themename is 'default'.

Parameters:
templateName -

setMargin

public void setMargin(boolean enabled)

Although most layouts support margins, CustomLayout does not. The behaviour of this layout is determined almost completely by the actual template.

Specified by:
setMargin in interface Layout
Overrides:
setMargin in class AbstractLayout

Throws:
UnsupportedOperationException

setMargin

public void setMargin(boolean topEnabled, boolean rightEnabled, boolean bottomEnabled, boolean leftEnabled)

Although most layouts support margins, CustomLayout does not. The behaviour of this layout is determined almost completely by the actual template.

Specified by:
setMargin in interface Layout
Overrides:
setMargin in class AbstractLayout

Throws:
UnsupportedOperationException

Overview Package Class Use Tree Deprecated Index Help

PREV CLASS NEXT CLASS FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000-2008 IT Mill Ltd. All Rights Reserved.

com.itmill.toolkit.ui Class CustomLayout

CustomLayout

CustomLayout

getTag

addComponent

addComponent

removeComponent

removeComponent

getComponentIterator

getComponent

paintContent

replaceComponent

setStyle

getTemplateName

setTemplateName

setMargin

setMargin

com.itmill.toolkit.ui
Class CustomLayout