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

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.VSplitPanel

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, 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.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, Container, ContainerResizedListener, Paintable, Iterable<com.google.gwt.user.client.ui.Widget>

Direct Known Subclasses:

VSplitPanelHorizontal, VSplitPanelVertical

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

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

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.IndexedPanel

com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Field Summary

static String	CLASSNAME
static int	ORIENTATION_HORIZONTAL
static int	ORIENTATION_VERTICAL
protected int	origScrollTop
protected com.google.gwt.user.client.Element	scrolledContainer
static String	SPLITTER_CLICK_EVENT_IDENTIFIER

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

DEBUG_ID_PREFIX

Constructor Summary

VSplitPanel()

VSplitPanel(int orientation)

Method Summary

protected void	constructDom()
RenderSpace	getAllocatedSpace(com.google.gwt.user.client.ui.Widget child) Returns the size currently allocated for the child component.
boolean	hasChildComponent(com.google.gwt.user.client.ui.Widget component) Is a given component child of this layout.
void	iLayout() This function is run when container box has been resized.
boolean	isEnabled()
void	onBrowserEvent(com.google.gwt.user.client.Event event)
void	onMouseDown(com.google.gwt.user.client.Event event)
void	onMouseMove(com.google.gwt.user.client.Event event)
void	onMouseUp(com.google.gwt.user.client.Event event)
boolean	remove(com.google.gwt.user.client.ui.Widget w)
void	replaceChildComponent(com.google.gwt.user.client.ui.Widget oldComponent, com.google.gwt.user.client.ui.Widget newComponent) Replace child of this layout with another component.
boolean	requestLayout(Set<Paintable> child) Called when a child components size has been updated in the rendering phase.
void	setEnabled(boolean enabled)
void	setHeight(String height)
void	setWidth(String width)
void	updateCaption(Paintable component, UIDL uidl) Update child components caption, description and error message.
void	updateFromUIDL(UIDL uidl, ApplicationConnection client)

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

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

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

add, add, adopt, adopt, clear, disown, doAttachChildren, doDetachChildren, orphan, remove

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onDetach, onLoad, onUnload, 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, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, sinkBitlessEvent, 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

SPLITTER_CLICK_EVENT_IDENTIFIER

public static final String SPLITTER_CLICK_EVENT_IDENTIFIER

See Also:

Constant Field Values

ORIENTATION_HORIZONTAL

public static final int ORIENTATION_HORIZONTAL

See Also:

Constant Field Values

ORIENTATION_VERTICAL

public static final int ORIENTATION_VERTICAL

See Also:

Constant Field Values

scrolledContainer

protected com.google.gwt.user.client.Element scrolledContainer

origScrollTop

protected int origScrollTop

Constructor Detail

VSplitPanel

public VSplitPanel()

VSplitPanel

public VSplitPanel(int orientation)

Method Detail

constructDom

protected void constructDom()

updateFromUIDL

public void updateFromUIDL(UIDL uidl,
                           ApplicationConnection client)

Specified by:

updateFromUIDL in interface Paintable

remove

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

Specified by:

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

Overrides:

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

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

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

onMouseDown

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

onMouseMove

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

onMouseUp

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

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

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:

hasChildComponent

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

Description copied from interface: Container

Is a given component child of this layout.

Specified by:

hasChildComponent in interface Container

Parameters:

component - Component to test.

Returns:

true iff component is a child of this layout.

replaceChildComponent

public void replaceChildComponent(com.google.gwt.user.client.ui.Widget oldComponent,
                                  com.google.gwt.user.client.ui.Widget newComponent)

Description copied from interface: Container

Replace child of this layout with another component. Each layout must be able to switch children. To to this, one must just give references to a current and new child.

Specified by:

replaceChildComponent in interface Container

Parameters:

oldComponent - Child to be replaced

newComponent - Child that replaces the oldComponent

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

updateCaption

public void updateCaption(Paintable component,
                          UIDL uidl)

Description copied from interface: Container

Update child components caption, description and error message.

Each component is responsible for maintaining its caption, description and error message. In most cases components doesn't want to do that and those elements reside outside of the component. Because of this layouts must provide service for it's childen to show those elements for them.

Specified by:

updateCaption in interface Container

Parameters:

component - Child component for which service is requested.

uidl - UIDL of the child component.

setEnabled

public void setEnabled(boolean enabled)

isEnabled

public boolean isEnabled()