com.vaadin.terminal.gwt.client.ui
Class VCustomLayout

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.google.gwt.user.client.ui.Panel
              com.google.gwt.user.client.ui.ComplexPanel
                  com.vaadin.terminal.gwt.client.ui.VCustomLayout

All Implemented Interfaces:

com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.IndexedPanel, Container, ContainerResizedListener, Paintable, Iterable<com.google.gwt.user.client.ui.Widget>

public class VCustomLayout
extends com.google.gwt.user.client.ui.ComplexPanel
implements Paintable, Container, ContainerResizedListener

Custom Layout implements complex layout defined with HTML template.

Author:

IT Mill

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

static String

CLASSNAME

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

VCustomLayout()

Method Summary

void	add(com.google.gwt.user.client.ui.Widget w) Adding widget without specifying location is not supported
void	clear() Clear all widgets from the layout
RenderSpace	getAllocatedSpace(com.google.gwt.user.client.ui.Widget child) Returns the size currently allocated for the child component.
String	getLocation(com.google.gwt.user.client.ui.Widget w) Get the location of an widget
boolean	hasChildComponent(com.google.gwt.user.client.ui.Widget component) Does this layout contain given child
void	iLayout() This function is run when container box has been resized.
void	notifyChildrenOfSizeChange() This method is published to JS side with the same name into first DOM node of custom layout.
void	onBrowserEvent(com.google.gwt.user.client.Event event)
void	onDetach()
boolean	remove(com.google.gwt.user.client.ui.Widget w) Removes given widget from the layout
void	replaceChildComponent(com.google.gwt.user.client.ui.Widget from, com.google.gwt.user.client.ui.Widget to) Replace child components
boolean	requestLayout(Set<Paintable> child) Called when a child components size has been updated in the rendering phase.
void	setHeight(String height)
void	setWidget(com.google.gwt.user.client.ui.Widget widget, String location) Sets widget to given location.
void	setWidth(String width)
void	updateCaption(Paintable component, UIDL uidl) Update caption for given widget
void	updateFromUIDL(UIDL uidl, ApplicationConnection client) Update the layout from UIDL

Methods inherited from class com.google.gwt.user.client.ui.ComplexPanel

add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, insert, insert, iterator, remove

Methods inherited from class com.google.gwt.user.client.ui.Panel

adopt, adopt, disown, doAttachChildren, doDetachChildren, onLoad, onUnload, orphan

Methods inherited from class com.google.gwt.user.client.ui.Widget

addDomHandler, addHandler, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setPixelSize, setSize, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, toString, unsinkEvents

Methods inherited from class java.lang.Object

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

Field Detail

CLASSNAME

public static final String CLASSNAME

See Also:

Constant Field Values

Constructor Detail

VCustomLayout

public VCustomLayout()

Method Detail

setWidget

public void setWidget(com.google.gwt.user.client.ui.Widget widget,
                      String location)

Sets widget to given location. If location already contains a widget it will be removed.

Parameters:

widget - Widget to be set into location.

location - location name where widget will be added

Throws:

IllegalArgumentException - if no such location is found in the layout.

updateFromUIDL

public void updateFromUIDL(UIDL uidl,
                           ApplicationConnection client)

Update the layout from UIDL

Specified by:

updateFromUIDL in interface Paintable

replaceChildComponent

public void replaceChildComponent(com.google.gwt.user.client.ui.Widget from,
                                  com.google.gwt.user.client.ui.Widget to)

Replace child components

Specified by:

replaceChildComponent in interface Container

Parameters:

from - Child to be replaced

to - Child that replaces the oldComponent

hasChildComponent

public boolean hasChildComponent(com.google.gwt.user.client.ui.Widget component)

Does this layout contain given child

Specified by:

hasChildComponent in interface Container

Parameters:

component - Component to test.

Returns:

true iff component is a child of this layout.

updateCaption

public void updateCaption(Paintable component,
                          UIDL uidl)

Update caption for given widget

Specified by:

updateCaption in interface Container

Parameters:

component - Child component for which service is requested.

uidl - UIDL of the child component.

getLocation

public String getLocation(com.google.gwt.user.client.ui.Widget w)

Get the location of an widget

remove

public boolean remove(com.google.gwt.user.client.ui.Widget w)

Removes given widget from the layout

Specified by:

remove in interface com.google.gwt.user.client.ui.HasWidgets

Overrides:

remove in class com.google.gwt.user.client.ui.ComplexPanel

add

public void add(com.google.gwt.user.client.ui.Widget w)

Adding widget without specifying location is not supported

Specified by:

add in interface com.google.gwt.user.client.ui.HasWidgets

Overrides:

add in class com.google.gwt.user.client.ui.Panel

clear

public void clear()

Clear all widgets from the layout

Specified by:

clear in interface com.google.gwt.user.client.ui.HasWidgets

Overrides:

clear in class com.google.gwt.user.client.ui.Panel

iLayout

public void iLayout()

Description copied from interface: ContainerResizedListener

This function is run when container box has been resized. Object implementing ContainerResizedListener is responsible to call the same function on its ancestors that implement NeedsLayout in case their container has resized. runAnchestorsLayout(HasWidgets parent) function from Util class may be a good helper for this.

Specified by:

iLayout in interface ContainerResizedListener

notifyChildrenOfSizeChange

public void notifyChildrenOfSizeChange()

This method is published to JS side with the same name into first DOM node of custom layout. This way if one implements some resizeable containers in custom layout he/she can notify children after resize.

onDetach

public void onDetach()

Overrides:

onDetach in class com.google.gwt.user.client.ui.Widget

requestLayout

public boolean requestLayout(Set<Paintable> child)

Description copied from interface: Container

Called when a child components size has been updated in the rendering phase.

Specified by:

requestLayout in interface Container

Parameters:

child - Set of child widgets whose size have changed

Returns:

true if the size of the Container remains the same, false if the event need to be propagated to the Containers parent

getAllocatedSpace

public RenderSpace getAllocatedSpace(com.google.gwt.user.client.ui.Widget child)

Description copied from interface: Container

Returns the size currently allocated for the child component.

Specified by:

getAllocatedSpace in interface Container

Returns:

onBrowserEvent

public void onBrowserEvent(com.google.gwt.user.client.Event event)

Specified by:

onBrowserEvent in interface com.google.gwt.user.client.EventListener

Overrides:

onBrowserEvent in class com.google.gwt.user.client.ui.Widget

setHeight

public void setHeight(String height)

Overrides:

setHeight in class com.google.gwt.user.client.ui.UIObject

setWidth

public void setWidth(String width)

Overrides:

setWidth in class com.google.gwt.user.client.ui.UIObject