Class Panel
Prev Chapter 17. Package com.itmill.toolkit.ui Next

Class Panel

Panel - a simple single component container.

Synopsis

Since

3.0

Inheritance Path.  java.lang.Object-> com.itmill.toolkit.ui.AbstractComponent -> com.itmill.toolkit.ui.AbstractComponentContainer -> com.itmill.toolkit.ui.Panel

Panel()

Create new empty panel. Ordered layout is used.

Panel(Layout)

Parameters

layout

The layout used in the panel.

Create new empty panel with given layout. Layout must be non-null.

Panel(String)

Parameters

caption

The caption used in the panel.

Create new empty panel with caption. Ordered layout is used.

Panel(String, Layout)

Parameters

caption

The caption of the panel.

layout

The layout used in the panel.

Create new empty panel with caption.

addComponent(Component)

Parameters

c

The component to be added.

Add a component into this container.

changeVariables(Object, Map)

See Also
changeVariables(java.lang.Object, java.util.Map)

componentAttachedToContainer(ComponentContainer.ComponentAttachEvent)

See Also
componentAttachedToContainer(com.itmill.toolkit.ui.ComponentContainer.ComponentAttachEvent)

Pass the events from underlying layout forwards.

componentDetachedFromContainer(ComponentContainer.ComponentDetachEvent)

See Also
componentDetachedFromContainer(com.itmill.toolkit.ui.ComponentContainer.ComponentDetachEvent)

Pass the events from underlying layout forwards.

getComponentIterator()

Parameters

return

Iterator of the components inside the container.

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

getHeight()

Parameters

return

height of the object in units specified by heightUnits property.

Description copied from interface: getHeight

Get height of the object. Negative number implies unspecified size (terminal is free to set the size).

getHeightUnits()

Parameters

return

units used in height property.

See Also
getHeightUnits()
Description copied from interface: getHeightUnits

Get height property units.

getLayout()

Parameters

return

Current layout of the panel.

Get the current layout of the panel.

getScrollOffsetX()

Parameters

return

Horizontal scrolling position in pixels.

Description copied from interface: getScrollOffsetX

Get scroll X offset.

Scrolling offset is the number of pixels this scrollable has been scrolled to left.

getScrollOffsetY()

Parameters

return

Vertical scrolling position in pixels.

Description copied from interface: getScrollOffsetY

Get scroll Y offset.

Scrolling offset is the number of pixels this scrollable has been scrolled to down.

getTag()

Parameters

return

Component UIDL tag as string.

Get component UIDL tag.

getWidth()

Parameters

return

width of the object in units specified by widthUnits property.

Description copied from interface: getWidth

Get width of the object. Negative number implies unspecified size (terminal is free to set the size).

getWidthUnits()

Parameters

return

units used in width property.

See Also
getWidthUnits()
Description copied from interface: getWidthUnits

Get width property units.

isScrollable()

Parameters

return

True iff the scrolling is allowed.

Description copied from interface: isScrollable

Is the scrolling enabled.

Enabling scrolling allows the user to scroll the scrollable view interactively

paintContent(PaintTarget)

Parameters

event

PaintEvent.

Exceptions

PaintException

The paint operation failed.

Paint the content of this component.

removeComponent(Component)

Parameters

c

The component to be added.

Remove a component from this container.

setHeight(int)

Parameters

height

The height to set

Sets the height in pixels. Use negative value to let the client decide the height.

setHeightUnits(int)

See Also
setHeightUnits(int)

Set height units. Panel supports only Sizeable.UNITS_PIXELS and this is ignored.

setLayout(Layout)

Parameters

layout

New layout of the panel.

Set the layout of the panel. All the components are moved to new layout.

setScrollable(boolean)

Parameters

isScrollingEnabled

True iff the scrolling is allowed.

Description copied from interface: setScrollable

Enable or disable scrolling..

Enabling scrolling allows the user to scroll the scrollable view interactively

setScrollOffsetX(int)

Parameters

xOffset.

Description copied from interface: setScrollOffsetX

Set scroll X offset.

Scrolling offset is the number of pixels this scrollable has been scrolled to left.

setScrollOffsetY(int)

Parameters

yOffset.

Description copied from interface: setScrollOffsetY

Set scroll Y offset.

Scrolling offset is the number of pixels this scrollable has been scrolled to down.

setWidth(int)

Parameters

width

The width to set

Sets the width in pixels. Use negative value to allow the client decide the width.

setWidthUnits(int)

See Also
setWidthUnits(int)

Set width units. Panel supports only Sizeable.UNITS_PIXELS, and this is ignored.

Prev Up Next
Class OrderedLayout Home Class ProgressIndicator