|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.vaadin.terminal.AbstractClientConnector com.vaadin.ui.AbstractComponent com.vaadin.ui.AbstractComponentContainer com.vaadin.ui.AbstractLayout com.vaadin.ui.CustomLayout
public class CustomLayout
A container component with freely designed layout and style. The layout consists of items with textually represented locations. Each item contains one sub-component, which can be any Vaadin component, such as a layout. The adapter and theme are responsible for rendering the layout with a given style by placing the items in the defined locations.
The placement of the locations is not fixed - different themes can define the locations in a way that is suitable for them. One typical example would be to create visual design for a web site as a custom layout: the visual design would define locations for "menu", "body", and "title", for example. The layout would then be implemented as an XHTML template for each theme.
The default theme handles the styles that are not defined by drawing the subcomponents just as in OrderedLayout.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.vaadin.ui.AbstractComponent |
---|
AbstractComponent.ComponentErrorEvent, AbstractComponent.ComponentErrorHandler |
Nested classes/interfaces inherited from interface com.vaadin.terminal.VariableOwner |
---|
VariableOwner.ErrorEvent |
Nested classes/interfaces inherited from interface com.vaadin.ui.Component |
---|
Component.ErrorEvent, Component.ErrorListener, Component.Event, Component.Focusable, Component.Listener |
Nested classes/interfaces inherited from interface com.vaadin.terminal.Sizeable |
---|
Sizeable.Unit |
Nested classes/interfaces inherited from interface com.vaadin.ui.Layout |
---|
Layout.AlignmentHandler, Layout.MarginHandler, Layout.MarginInfo, Layout.SpacingHandler |
Nested classes/interfaces inherited from interface com.vaadin.ui.ComponentContainer |
---|
ComponentContainer.ComponentAttachEvent, ComponentContainer.ComponentAttachListener, ComponentContainer.ComponentDetachEvent, ComponentContainer.ComponentDetachListener |
Field Summary |
---|
Fields inherited from class com.vaadin.ui.AbstractLayout |
---|
margins |
Fields inherited from interface com.vaadin.terminal.Sizeable |
---|
SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS |
Constructor Summary | |
---|---|
protected |
CustomLayout()
Default constructor only used by subclasses. |
|
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. |
void |
changeVariables(Object source,
Map<String,Object> variables)
Called when one or more variables handled by the implementing class are changed. |
Component |
getComponent(String location)
Gets the child-component by its location. |
int |
getComponentCount()
Gets the number of contained components. |
Iterator<Component> |
getComponentIterator()
Gets the component container iterator for going trough all the components in the container. |
CustomLayoutState |
getState()
Returns the shared state bean with information to be sent from the server to the client. |
String |
getTemplateContents()
Get the contents of the template |
String |
getTemplateName()
Get the name of the template |
protected void |
initTemplateContentsFromInputStream(InputStream templateStream)
|
void |
paintContent(PaintTarget target)
Paints the Paintable into a UIDL stream. |
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 |
setTemplateContents(String templateContents)
Set the contents of the template used to draw the custom layout. |
void |
setTemplateName(String templateName)
Set the name of the template used to draw custom layout. |
Methods inherited from class com.vaadin.ui.AbstractLayout |
---|
getMargin, setMargin |
Methods inherited from class com.vaadin.ui.AbstractComponentContainer |
---|
addListener, addListener, fireComponentAttachEvent, fireComponentDetachEvent, isComponentVisible, iterator, moveComponentsFrom, removeAllComponents, removeListener, removeListener, setHeight, setVisible, setWidth |
Methods inherited from class com.vaadin.terminal.AbstractClientConnector |
---|
addExtension, addMethodInvocationToQueue, createState, getAllChildrenIterable, getConnectorId, getExtensions, getRpcManager, getRpcProxy, getStateType, registerRpc, registerRpc, removeExtension, requestRepaintAll, retrievePendingRpcCalls |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.vaadin.terminal.VariableOwner |
---|
isEnabled, isImmediate |
Methods inherited from interface com.vaadin.ui.Component |
---|
addListener, addStyleName, attach, getApplication, getCaption, getDebugId, getIcon, getLocale, getParent, getRoot, getStyleName, isEnabled, isReadOnly, isVisible, removeListener, removeStyleName, setCaption, setDebugId, setEnabled, setIcon, setReadOnly, setStyleName, setVisible, updateState |
Methods inherited from interface com.vaadin.terminal.gwt.server.ClientConnector |
---|
detach, getExtensions, getStateType, isConnectorEnabled, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setParent |
Methods inherited from interface com.vaadin.terminal.gwt.client.Connector |
---|
getConnectorId |
Methods inherited from interface com.vaadin.terminal.gwt.server.RpcTarget |
---|
getRpcManager |
Methods inherited from interface com.vaadin.terminal.Sizeable |
---|
getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setSizeFull, setSizeUndefined, setWidth, setWidth |
Methods inherited from interface com.vaadin.ui.ComponentContainer |
---|
addListener, addListener, moveComponentsFrom, removeAllComponents, removeListener, removeListener |
Methods inherited from interface com.vaadin.ui.HasComponents |
---|
isComponentVisible |
Methods inherited from interface java.lang.Iterable |
---|
iterator |
Constructor Detail |
---|
protected CustomLayout()
setTemplateName(String)
, that makes layout fetch the template
from theme, or setTemplateContents(String)
.
public CustomLayout(InputStream templateStream) throws IOException
templateStream
- Stream containing template data. Must be using UTF-8 encoding.
To use a String as a template use for instance new
ByteArrayInputStream("".getBytes()).streamLength
- Length of the templateStream
IOException
public CustomLayout(String template)
Method Detail |
---|
protected void initTemplateContentsFromInputStream(InputStream templateStream) throws IOException
IOException
public CustomLayoutState getState()
AbstractComponent
getState
in interface Connector
getState
in interface Component
getState
in class AbstractLayout
public void addComponent(Component c, String location)
c
- the component to be added.location
- the location of the component.public void addComponent(Component c)
addComponent
in interface ComponentContainer
addComponent
in class AbstractComponentContainer
c
- the component to be added.ComponentContainer.addComponent(Component)
public void removeComponent(Component c)
removeComponent
in interface ComponentContainer
removeComponent
in class AbstractComponentContainer
c
- the component to be removed.ComponentContainer.removeComponent(Component)
public void removeComponent(String location)
location
- the Location identifier of the component.public Iterator<Component> getComponentIterator()
getComponentIterator
in interface HasComponents
public int getComponentCount()
getComponentIterator()
.
getComponentCount
in interface ComponentContainer
public Component getComponent(String location)
location
- the name of the location where the requested component
resides.
public void replaceComponent(Component oldComponent, Component newComponent)
ComponentContainer
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.
replaceComponent
in interface ComponentContainer
oldComponent
- the old component that will be replaced.newComponent
- the new component to be replaced.public String getTemplateName()
public String getTemplateContents()
public void setTemplateName(String templateName)
templateName
- public void setTemplateContents(String templateContents)
templateContents
- public void setMargin(boolean enabled)
setMargin
in interface Layout
setMargin
in class AbstractLayout
UnsupportedOperationException
public void setMargin(boolean topEnabled, boolean rightEnabled, boolean bottomEnabled, boolean leftEnabled)
setMargin
in interface Layout
setMargin
in class AbstractLayout
UnsupportedOperationException
public void changeVariables(Object source, Map<String,Object> variables)
VariableOwner
changeVariables
in interface VariableOwner
source
- the Source of the variable change. This is the origin of the
event. For example in Web Adapter this is the request.variables
- the Mapping from variable names to new variable values.public void paintContent(PaintTarget target) throws PaintException
Vaadin6Component
Paints the Paintable into a UIDL stream. This method creates the UIDL sequence describing it and outputs it to the given UIDL stream.
It is called when the contents of the component should be painted in response to the component first being shown or having been altered so that its visual representation is changed.
paintContent
in interface Vaadin6Component
target
- the target UIDL stream where the component should paint itself
to.
PaintException
- if the paint operation failed.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |