Chapter 17. Package com.itmill.toolkit.ui
Table of Contents
- Package Specification
- Class AbstractComponent
- Synopsis
- AbstractComponent()
- addListener(Class, Object, Method)
- addListener(Class, Object, String)
- addListener(Component.Listener)
- attach()
- childRequestedRepaint(Collection)
- detach()
- getApplication()
- getCaption()
- getComponentError()
- getData()
- getDescription()
- getErrorMessage()
- getIcon()
- getLocale()
- getParent()
- getStyle()
- getTag()
- getWindow()
- isEnabled()
- isReadOnly()
- isVisible()
- paintContent(PaintTarget)
- removeListener(Class, Object)
- removeListener(Class, Object, Method)
- removeListener(Class, Object, String)
- removeListener(Component.Listener)
- setCaption(String)
- setComponentError(ErrorMessage)
- setData(Object)
- setDescription(String)
- setEnabled(boolean)
- setIcon(Resource)
- setImmediate(boolean)
- setLocale(Locale)
- setParent(Component)
- setReadOnly(boolean)
- setStyle(String)
- setVisible(boolean)
- Class AbstractComponentContainer
- Synopsis
- AbstractComponentContainer()
- addComponent(Component)
- addListener(ComponentContainer.ComponentAttachListener)
- addListener(ComponentContainer.ComponentDetachListener)
- attach()
- detach()
- moveComponentsFrom(ComponentContainer)
- removeAllComponents()
- removeComponent(Component)
- removeListener(ComponentContainer.ComponentAttachListener)
- removeListener(ComponentContainer.ComponentDetachListener)
- Class AbstractField
- Synopsis
- addListener(Property.ReadOnlyStatusChangeListener)
- addValidator(Validator)
- attach()
- constructField(Class)
- finalize()
- focus()
- getErrorMessage()
- getFocusableId()
- getPropertyDataSource()
- getTabIndex()
- getValidators()
- getValue()
- isInvalidAllowed()
- isReadOnly()
- isRequired()
- isValid()
- removeListener(Property.ReadOnlyStatusChangeListener)
- removeValidator(Validator)
- setInvalidAllowed(boolean)
- setPropertyDataSource(Property)
- setReadOnly(boolean)
- setRequired(boolean)
- setTabIndex(int)
- setValue(Object)
- toString()
- valueChange(Property.ValueChangeEvent)
- Class AbstractField.ReadOnlyStatusChangeEvent
- Class BaseFieldFactory
- Class Button
- Synopsis
- Button()
- Button(String)
- Button(String, boolean)
- Button(String, Button.ClickListener)
- Button(String, Object, String)
- Button(String, Property)
- addListener(Button.ClickListener)
- changeVariables(Object, Map)
- getTag()
- getType()
- isSwitchMode()
- paintContent(PaintTarget)
- removeListener(Button.ClickListener)
- setImmediate(boolean)
- setSwitchMode(boolean)
- Class Button.ClickEvent
- Interface Button.ClickListener
- Interface Component
- Synopsis
- addListener(Component.Listener)
- attach()
- childRequestedRepaint(Collection)
- detach()
- getApplication()
- getCaption()
- getIcon()
- getLocale()
- getParent()
- getStyle()
- getWindow()
- isEnabled()
- isReadOnly()
- isVisible()
- removeListener(Component.Listener)
- setEnabled(boolean)
- setParent(Component)
- setReadOnly(boolean)
- setStyle(String)
- setVisible(boolean)
- Class Component.ErrorEvent
- Interface Component.ErrorListener
- Class Component.Event
- Interface Component.Focusable
- Interface Component.Listener
- Interface ComponentContainer
- Synopsis
- addComponent(Component)
- addListener(ComponentContainer.ComponentAttachListener)
- addListener(ComponentContainer.ComponentDetachListener)
- getComponentIterator()
- moveComponentsFrom(ComponentContainer)
- removeAllComponents()
- removeComponent(Component)
- removeListener(ComponentContainer.ComponentAttachListener)
- removeListener(ComponentContainer.ComponentDetachListener)
- replaceComponent(Component, Component)
- Class ComponentContainer.ComponentAttachEvent
- Interface ComponentContainer.ComponentAttachListener
- Class ComponentContainer.ComponentDetachEvent
- Interface ComponentContainer.ComponentDetachListener
- Class CustomComponent
- Synopsis
- CustomComponent()
- CustomComponent(Component)
- addListener(Component.Listener)
- attach()
- changeVariables(Object, Map)
- childRequestedRepaint(Collection)
- detach()
- getApplication()
- getCaption()
- getComponentType()
- getIcon()
- getLocale()
- getParent()
- getStyle()
- getWindow()
- isEnabled()
- isImmediate()
- isReadOnly()
- isVisible()
- removeListener(Component.Listener)
- setComponentType(String)
- setEnabled(boolean)
- setParent(Component)
- setReadOnly(boolean)
- setStyle(String)
- setVisible(boolean)
- Class CustomLayout
- Class DateField
- Class Embedded
- Synopsis
- Embedded()
- Embedded(String)
- Embedded(String, Resource)
- TYPE_IMAGE
- TYPE_OBJECT
- getArchive()
- getClassId()
- getCodebase()
- getCodetype()
- getHeight()
- getHeightUnits()
- getMimeType()
- getParameter(String)
- getParameterNames()
- getSource()
- getStandby()
- getTag()
- getType()
- getWidth()
- getWidthUnits()
- paintContent(PaintTarget)
- removeParameter(String)
- setArchive(String)
- setClassId(String)
- setCodebase(String)
- setCodetype(String)
- setHeight(int)
- setHeightUnits(int)
- setMimeType(String)
- setParameter(String, String)
- setSource(Resource)
- setStandby(String)
- setType(int)
- setWidth(int)
- setWidthUnits(int)
- Interface Field
- Class Field.ValueChangeEvent
- Interface FieldFactory
- Class Form
- Synopsis
- Form()
- Form(Layout)
- Form(Layout, FieldFactory)
- addField(Object, Field)
- addItemProperty(Object, Property)
- addValidator(Validator)
- attach()
- commit()
- detach()
- discard()
- focus()
- getField(Object)
- getFieldFactory()
- getItemProperty(Object)
- getItemPropertyIds()
- getLayout()
- getType()
- getValidators()
- getVisibleItemProperties()
- isInvalidAllowed()
- isModified()
- isReadThrough()
- isValid()
- isWriteThrough()
- removeAllProperties()
- removeItemProperty(Object)
- removeValidator(Validator)
- replaceWithSelect(Object, Object[], Object[])
- setFieldFactory(FieldFactory)
- setInvalidAllowed(boolean)
- setItemDataSource(Item)
- setItemDataSource(Item, Collection)
- setLayout(Layout)
- setReadOnly(boolean)
- setReadThrough(boolean)
- setTabIndex(int)
- setVisibleItemProperties(Collection)
- setWriteThrough(boolean)
- validate()
- Class FrameWindow
- Class FrameWindow.Frame
- Class FrameWindow.Frameset
- Synopsis
- getFrame(int)
- getFrame(String)
- getFrames()
- isVertical()
- newFrame(Resource, String)
- newFrame(Resource, String, int)
- newFrame(URL, String)
- newFrame(URL, String, int)
- newFrame(Window)
- newFrame(Window, int)
- newFrameset(boolean, int)
- removeAllFrames()
- removeFrame(FrameWindow.Frame)
- setVertical(boolean)
- size()
- Class GridLayout
- Synopsis
- GridLayout()
- GridLayout(int, int)
- addComponent(Component)
- addComponent(Component, int, int)
- addComponent(Component, int, int, int, int)
- getComponentIterator()
- getCursorX()
- getCursorY()
- getHeight()
- getTag()
- getWidth()
- newLine()
- paintContent(PaintTarget)
- removeComponent(Component)
- removeComponent(int, int)
- setHeight(int)
- setWidth(int)
- space()
- Class GridLayout.Area
- Exception GridLayout.OutOfBoundsException
- Exception GridLayout.OverlapsException
- Class Label
- Synopsis
- Label()
- Label(Property)
- Label(Property, int)
- Label(String)
- Label(String, int)
- CONTENT_DEFAULT
- CONTENT_PREFORMATTED
- CONTENT_RAW
- CONTENT_TEXT
- CONTENT_UIDL
- CONTENT_XHTML
- CONTENT_XML
- addListener(Property.ValueChangeListener)
- compareTo(Object)
- getContentMode()
- getPropertyDataSource()
- getTag()
- getType()
- getValue()
- isReadOnly()
- paintContent(PaintTarget)
- removeListener(Property.ValueChangeListener)
- setContentMode(int)
- setPropertyDataSource(Property)
- setReadOnly(boolean)
- setValue(Object)
- toString()
- valueChange(Property.ValueChangeEvent)
- Class Label.ValueChangeEvent
- Interface Layout
- Class Link
- Synopsis
- Link()
- Link(String, Resource)
- Link(String, Resource, String, int, int, int)
- Link(Window)
- getResource()
- getTag()
- getTargetBorder()
- getTargetHeight()
- getTargetName()
- getTargetWidth()
- getWindow()
- paintContent(PaintTarget)
- setResource(Resource)
- setTargetBorder(int)
- setTargetHeight(int)
- setTargetName(String)
- setTargetWidth(int)
- setWindow(Window)
- Class OrderedLayout
- Class Panel
- Synopsis
- Panel()
- Panel(Layout)
- Panel(String)
- Panel(String, Layout)
- addComponent(Component)
- changeVariables(Object, Map)
- componentAttachedToContainer(ComponentContainer.ComponentAttachEvent)
- componentDetachedFromContainer(ComponentContainer.ComponentDetachEvent)
- getComponentIterator()
- getHeight()
- getHeightUnits()
- getLayout()
- getScrollOffsetX()
- getScrollOffsetY()
- getTag()
- getWidth()
- getWidthUnits()
- isScrollable()
- paintContent(PaintTarget)
- removeComponent(Component)
- setHeight(int)
- setHeightUnits(int)
- setLayout(Layout)
- setScrollable(boolean)
- setScrollOffsetX(int)
- setScrollOffsetY(int)
- setWidth(int)
- setWidthUnits(int)
- Class ProgressIndicator
- Synopsis
- ProgressIndicator()
- ProgressIndicator(Float)
- ProgressIndicator(Property)
- CONTENT_PREFORMATTED
- CONTENT_TEXT
- getContentMode()
- getPollingInterval()
- getPropertyDataSource()
- getTag()
- getType()
- getValue()
- isReadOnly()
- paintContent(PaintTarget)
- setIndeterminate(boolean)
- setPollingInterval(int)
- setPropertyDataSource(Property)
- setReadOnly(boolean)
- setValue(Object)
- toString()
- Class Select
- Synopsis
- Select()
- Select(String)
- Select(String, Collection)
- Select(String, Container)
- ITEM_CAPTION_MODE_EXPLICIT
- ITEM_CAPTION_MODE_EXPLICIT_DEFAULTS_ID
- ITEM_CAPTION_MODE_ICON_ONLY
- ITEM_CAPTION_MODE_ID
- ITEM_CAPTION_MODE_INDEX
- ITEM_CAPTION_MODE_ITEM
- ITEM_CAPTION_MODE_PROPERTY
- addContainerProperty(Object, Class, Object)
- addItem()
- addItem(Object)
- addListener(Container.ItemSetChangeListener)
- addListener(Container.PropertySetChangeListener)
- attach()
- changeVariables(Object, Map)
- containerItemSetChange(Container.ItemSetChangeEvent)
- containerPropertySetChange(Container.PropertySetChangeEvent)
- containsId(Object)
- detach()
- getContainerDataSource()
- getContainerProperty(Object, Object)
- getContainerPropertyIds()
- getItem(Object)
- getItemCaption(Object)
- getItemCaptionMode()
- getItemCaptionPropertyId()
- getItemIcon(Object)
- getItemIconPropertyId()
- getItemIds()
- getNullSelectionItemId()
- getTag()
- getType()
- getType(Object)
- getValue()
- getVisibleItemIds()
- isMultiSelect()
- isNewItemsAllowed()
- isSelected(Object)
- paintContent(PaintTarget)
- removeAllItems()
- removeContainerProperty(Object)
- removeItem(Object)
- removeListener(Container.ItemSetChangeListener)
- removeListener(Container.PropertySetChangeListener)
- select(Object)
- setContainerDataSource(Container)
- setItemCaption(Object, String)
- setItemCaptionMode(int)
- setItemCaptionPropertyId(Object)
- setItemIcon(Object, Resource)
- setItemIconPropertyId(Object)
- setMultiSelect(boolean)
- setNewItemsAllowed(boolean)
- setNullSelectionItemId(Object)
- setValue(Object)
- size()
- unselect(Object)
- Class TabSheet
- Synopsis
- TabSheet()
- addComponent(Component)
- addListener(TabSheet.SelectedTabChangeListener)
- addTab(Component, String, Resource)
- areTabsHidden()
- changeVariables(Object, Map)
- getComponentIterator()
- getSelectedTab()
- getTabCaption(Component)
- getTabIcon(Component)
- getTag()
- hideTabs(boolean)
- moveComponentsFrom(ComponentContainer)
- paintContent(PaintTarget)
- removeComponent(Component)
- removeListener(TabSheet.SelectedTabChangeListener)
- setSelectedTab(Component)
- setTabCaption(Component, String)
- setTabIcon(Component, Resource)
- Class TabSheet.SelectedTabChangeEvent
- Interface TabSheet.SelectedTabChangeListener
- Class Table
- Synopsis
- Table()
- Table(String)
- Table(String, Container)
- ALIGN_CENTER
- ALIGN_LEFT
- ALIGN_RIGHT
- COLUMN_HEADER_MODE_EXPLICIT
- COLUMN_HEADER_MODE_EXPLICIT_DEFAULTS_ID
- COLUMN_HEADER_MODE_HIDDEN
- COLUMN_HEADER_MODE_ID
- ROW_HEADER_MODE_EXPLICIT
- ROW_HEADER_MODE_EXPLICIT_DEFAULTS_ID
- ROW_HEADER_MODE_HIDDEN
- ROW_HEADER_MODE_ICON_ONLY
- ROW_HEADER_MODE_ID
- ROW_HEADER_MODE_INDEX
- ROW_HEADER_MODE_ITEM
- ROW_HEADER_MODE_PROPERTY
- addActionHandler(Action.Handler)
- addContainerProperty(Object, Class, Object)
- addContainerProperty(Object, Class, Object, String, Resource, String)
- addItem(Object[], Object)
- addItemAfter(Object)
- addItemAfter(Object, Object)
- attach()
- changeVariables(Object, Map)
- containerItemSetChange(Container.ItemSetChangeEvent)
- containerPropertySetChange(Container.PropertySetChangeEvent)
- detach()
- firstItemId()
- focus()
- getColumnAlignment(Object)
- getColumnAlignments()
- getColumnHeader(Object)
- getColumnHeaderMode()
- getColumnHeaders()
- getColumnIcon(Object)
- getColumnIcons()
- getCurrentPageFirstItemId()
- getCurrentPageFirstItemIndex()
- getFieldFactory()
- getHeight()
- getHeightUnits()
- getPageLength()
- getRowHeaderMode()
- getSortableContainerPropertyIds()
- getSortContainerPropertyId()
- getTag()
- getVisibleColumns()
- getVisibleItemIds()
- getWidth()
- getWidthUnits()
- isColumnCollapsed(Object)
- isColumnCollapsingAllowed()
- isColumnReorderingAllowed()
- isEditable()
- isFirstId(Object)
- isLastId(Object)
- isPageBufferingEnabled()
- isSelectable()
- isSortAscending()
- isSortDisabled()
- lastItemId()
- nextItemId(Object)
- paintContent(PaintTarget)
- prevItemId(Object)
- refreshCurrentPage()
- removeActionHandler(Action.Handler)
- removeAllItems()
- removeContainerProperty(Object)
- removeItem(Object)
- setColumnAlignment(Object, String)
- setColumnAlignments(String[])
- setColumnCollapsed(Object, boolean)
- setColumnCollapsingAllowed(boolean)
- setColumnHeader(Object, String)
- setColumnHeaderMode(int)
- setColumnHeaders(String[])
- setColumnIcon(Object, Resource)
- setColumnIcons(Resource[])
- setColumnReorderingAllowed(boolean)
- setContainerDataSource(Container)
- setCurrentPageFirstItemId(Object)
- setCurrentPageFirstItemIndex(int)
- setEditable(boolean)
- setFieldFactory(FieldFactory)
- setHeight(int)
- setHeightUnits(int)
- setLazyLoading(boolean)
- setNewItemsAllowed(boolean)
- setPageBufferingEnabled(boolean)
- setPageLength(int)
- setRowHeaderMode(int)
- setSelectable(boolean)
- setSortAscending(boolean)
- setSortContainerPropertyId(Object)
- setSortDisabled(boolean)
- setVisibleColumns(Object[])
- setWidth(int)
- setWidthUnits(int)
- sort()
- sort(Object[], boolean[])
- valueChange(Property.ValueChangeEvent)
- Class TextField
- Synopsis
- TextField()
- TextField(Property)
- TextField(String)
- TextField(String, Property)
- TextField(String, String)
- getColumns()
- getFormat()
- getNullRepresentation()
- getRows()
- isNullSettingAllowed()
- isSecret()
- isWordwrap()
- setColumns(int)
- setFormat(Format)
- setNullRepresentation(String)
- setNullSettingAllowed(boolean)
- setRows(int)
- setSecret(boolean)
- setWordwrap(boolean)
- Class Tree
- Synopsis
- Tree()
- Tree(String)
- Tree(String, Container)
- addActionHandler(Action.Handler)
- addListener(Tree.CollapseListener)
- addListener(Tree.ExpandListener)
- areChildrenAllowed(Object)
- changeVariables(Object, Map)
- collapseItem(Object)
- collapseItemsRecursively(Object)
- expandItem(Object)
- expandItemsRecursively(Object)
- focus()
- getChildren(Object)
- getParent(Object)
- getTag()
- getVisibleItemIds()
- hasChildren(Object)
- isExpanded(Object)
- isRoot(Object)
- isSelectable()
- paintContent(PaintTarget)
- removeActionHandler(Action.Handler)
- removeListener(Tree.CollapseListener)
- removeListener(Tree.ExpandListener)
- rootItemIds()
- setChildrenAllowed(Object, boolean)
- setContainerDataSource(Container)
- setLazyLoading(boolean)
- setNewItemsAllowed(boolean)
- setParent(Object, Object)
- setSelectable(boolean)
- Class Tree.CollapseEvent
- Interface Tree.CollapseListener
- Class Tree.ExpandEvent
- Interface Tree.ExpandListener
- Class Upload
- Synopsis
- Upload(String, Upload.Receiver)
- addListener(Upload.FailedListener)
- addListener(Upload.FinishedListener)
- addListener(Upload.SucceededListener)
- changeVariables(Object, Map)
- focus()
- getFocusableId()
- getReceiver()
- getTabIndex()
- getTag()
- paintContent(PaintTarget)
- removeListener(Upload.FailedListener)
- removeListener(Upload.FinishedListener)
- removeListener(Upload.SucceededListener)
- setReceiver(Upload.Receiver)
- setTabIndex(int)
- Class Upload.FailedEvent
- Interface Upload.FailedListener
- Class Upload.FinishedEvent
- Interface Upload.FinishedListener
- Interface Upload.Receiver
- Class Upload.SucceededEvent
- Interface Upload.SucceededListener
- Class Window
- Synopsis
- Window()
- Window(String)
- Window(String, Layout)
- BORDER_DEFAULT
- BORDER_MINIMAL
- BORDER_NONE
- addParameterHandler(ParameterHandler)
- addURIHandler(URIHandler)
- changeVariables(Object, Map)
- getApplication()
- getBorder()
- getFocusableById(long)
- getFocusedComponent()
- getName()
- getNewFocusableId(Component.Focusable)
- getParent()
- getTag()
- getTerminal()
- getTheme()
- getURL()
- getWindow()
- handleParameters(Map)
- handleURI(URL, String)
- open(Resource)
- open(Resource, String)
- open(Resource, String, int, int, int)
- paintContent(PaintTarget)
- removeFocusableId(long)
- removeParameterHandler(ParameterHandler)
- removeURIHandler(URIHandler)
- setApplication(Application)
- setBorder(int)
- setFocusedComponent(Component.Focusable)
- setHeightUnits(int)
- setName(String)
- setParent(Component)
- setTerminal(Terminal)
- setTheme(String)
- setWidthUnits(int)
Provides interfaces and classes in the IT Mill Toolkit.
Interface hierarchy
The general interface hierarchy looks like this:
Note that the above picture includes only the main interfaces. This package includes several other lesser subinterfaces which are not significant in this scope. The interfaces not appearing here are documented with the classes that define them.
The {@link com.itmill.toolkit.ui.Button} for
example won't need to implement the lower level interfaces described
below. Note that the classes and interfaces required by the component event
framework are defined in
com.itmill.toolkit.ui.Component
.
The next level in the component hierarchy are the classes implementing
the
com.itmill.toolkit.ui.ComponentContainer
interface. It adds the
capacity to contain other components to
com.itmill.toolkit.ui.Component
with a simple API.
The third and last level is the
com.itmill.toolkit.ui.Layout
,
which adds the concept of location to the components contained in a
com.itmill.toolkit.ui.ComponentContainer
. It can be used to create
containers whose contents can be positioned arbitrarily.
Component class hierarchy
The actual component classes form a hierarchy like this:
Underlined classes are abstract.
At the top level is
com.itmill.toolkit.ui.AbstractComponent
which implements the
com.itmill.toolkit.ui.Component
interface. As
the name suggests it is abstract, but it does include a default
implementation for all methods defined in
Component
so that
a component is free to override only those functionalities it needs.
As seen in the picture,
AbstractComponent
serves as the
superclass for several "real" components, but it also has a some abstract
extensions.
com.itmill.toolkit.ui.AbstractComponentContainer
serves
as the root class for all components (for example, panels and windows) who
can contain other components.
com.itmill.toolkit.ui.AbstractField
,
on the other hand, implements several interfaces to provide a base class for
components that are used for data display and manipulation.
<!-- Put @see and @since tags down here. -->