org.kalmeo.kuix.widget
Class List

java.lang.Object
  org.kalmeo.kuix.widget.Widget
      org.kalmeo.kuix.widget.List

Direct Known Subclasses:

Menu.MenuPopup, RadioGroup, TabFolder

public class List
extends Widget

This class represents a list.

For further informations, visit the Kuix widgets reference page.

Author:

bbeaulant

Nested Class Summary

Nested classes/interfaces inherited from class org.kalmeo.kuix.widget.Widget

Widget.BindInstruction

Field Summary

Fields inherited from class org.kalmeo.kuix.widget.Widget

bindInstructions, DEFAULT_ALIGN, DEFAULT_BACKGROUND_ALIGN, DEFAULT_BACKGROUND_REPEAT, DEFAULT_BORDER, DEFAULT_GAP, DEFAULT_MARGIN, DEFAULT_MIN_SIZE, DEFAULT_PADDING, DEFAULT_SPAN, DEFAULT_WEIGHT, next, parent, previous

Constructor Summary

List()
Construct a List

List(java.lang.String tag)
Construct a List

Method Summary

Widget	addItem(DataProvider item) Add an item value
Widget	addItem(DataProvider item, DataProvider referenceItem, boolean after) Add an item value
Widget	addItem(DataProvider item, java.io.InputStream renderer) Add an item value
Widget	addItem(DataProvider item, java.io.InputStream renderer, DataProvider referenceItem, boolean after) Add an item value near an other.
protected java.lang.Object	getDefaultStylePropertyValue(java.lang.String name) Returns the de default style property value for name property, or null.
Widget	getItemWidget(DataProvider item)
java.io.ByteArrayInputStream	getRenderer()
boolean	isObjectAttribute(java.lang.String name) Check if the given attribute require an Object value.
boolean	processItemsModelUpdateEvent(byte type, java.lang.String property, DataProvider item, LinkedListEnumeration itemsEnumeration) Process an items model update event.
void	removeAllItems() Remove all items
boolean	removeItem(DataProvider item) Remove an item value if it exists in the List
boolean	setAttribute(java.lang.String name, java.lang.String value) Set the value to the specified attribute representing by the name
void	setItems(LinkedListEnumeration itemsEnumeration) Redifine all item values
boolean	setObjectAttribute(java.lang.String name, java.lang.Object value) Set the Object value to the specified attribute representing by the name.
void	setRenderer(java.io.ByteArrayInputStream renderer)

Methods inherited from class org.kalmeo.kuix.widget.Widget

add, add, bringNear, bringToFront, catchChildrenFrom, cleanUp, cleanUpChildren, clearCachedStyle, doLayout, getAlign, getAttribute, getAuthorStyle, getAvailablePseudoClasses, getBackgroundAlign, getBackgroundColor, getBackgroundImage, getBackgroundRepeat, getBorder, getBorderAlign, getBorderColor, getBorderImage, getBorderStroke, getCachedMetrics, getChild, getColor, getDataProvider, getDesktop, getDisplayX, getDisplayY, getFocusManager, getGap, getGrayedColor, getHeight, getId, getInheritedTag, getInnerHeight, getInnerWidth, getInsets, getInternalChildInstance, getLastChild, getLayout, getLayoutData, getMargin, getMinSize, getOtherFocus, getPadding, getPreferredSize, getSpan, getStyleClasses, getStylePropertyValue, getStyles, getTag, getWeight, getWidget, getWidgetAt, getWidgetAt, getWidth, getX, getY, hasBindInstruction, hasShortcutKeyCodes, hasShortcuts, invalidate, invalidate, invalidateAppearance, invalidateAppearanceRegion, invalidateStylePropertiesCache, isFocusable, isFocused, isFocusWidgetChild, isIndividualyVisible, isInvalidated, isInWidgetTree, isPseudoClassCompatible, isShortcutKeyCodeCompatible, isVisible, markAsValidate, needToComputePreferredSize, onAdded, onChildAdded, onChildRemoved, onFocus, onLostFocus, onRemoved, paint, paintBackground, paintBorder, paintChildrenImpl, paintImpl, paintMosaicImage, parseAuthorStyle, processActionEvent, processDataBindEvent, processFocusEvent, processKeyEvent, processModelUpdateEvent, processPointerEvent, processShortcutKeyEvent, propagateFocusEvent, remove, removeAll, removeAttributeBindInstruction, requestBackwardFocus, requestFocus, requestForwardFocus, sendToBack, setAttributeBindInstruction, setAuthorStyle, setBounds, setDataProvider, setId, setShortcutKeyCodes, setShortcuts, setStyleClass, setStyleClasses, setVisible

Methods inherited from class java.lang.Object

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

Constructor Detail

List

public List()

Construct a List

List

public List(java.lang.String tag)

Construct a List

Parameters:

tag -

Method Detail

setAttribute

public boolean setAttribute(java.lang.String name,
                            java.lang.String value)

Description copied from class: Widget

Set the value to the specified attribute representing by the name

Overrides:

setAttribute in class Widget

Returns:

true if the attribute exists

setObjectAttribute

public boolean setObjectAttribute(java.lang.String name,
                                  java.lang.Object value)

Description copied from class: Widget

Set the Object value to the specified attribute representing by the name.

Overrides:

setObjectAttribute in class Widget

Returns:

isObjectAttribute

public boolean isObjectAttribute(java.lang.String name)

Description copied from class: Widget

Check if the given attribute require an Object value.

Overrides:

isObjectAttribute in class Widget

Returns:

true if the given attribute require an Object value

getDefaultStylePropertyValue

protected java.lang.Object getDefaultStylePropertyValue(java.lang.String name)

Description copied from class: Widget

Returns the de default style property value for name property, or null.

Overrides:

getDefaultStylePropertyValue in class Widget

Returns:

The de default style property value for name property

getRenderer

public java.io.ByteArrayInputStream getRenderer()

Returns:

the renderer

setRenderer

public void setRenderer(java.io.ByteArrayInputStream renderer)

Parameters:

renderer - the renderer to set

setItems

public void setItems(LinkedListEnumeration itemsEnumeration)

Redifine all item values

Parameters:

itemsEnumeration -

addItem

public Widget addItem(DataProvider item)

Add an item value

Parameters:

item -

Returns:

The added Widget or null if no renderer is set on the list.

addItem

public Widget addItem(DataProvider item,
                      java.io.InputStream renderer)

Add an item value

Parameters:

item -

renderer -

Returns:

The added Widget

addItem

public Widget addItem(DataProvider item,
                      DataProvider referenceItem,
                      boolean after)

Add an item value

Parameters:

item -

enabled -

prepend -

Returns:

The added Widget or null if no renderer is set on the list

addItem

public Widget addItem(DataProvider item,
                      java.io.InputStream renderer,
                      DataProvider referenceItem,
                      boolean after)

Add an item value near an other.

Parameters:

item -

renderer -

referenceItem -

after -

Returns:

The added Widget

removeItem

public boolean removeItem(DataProvider item)

Remove an item value if it exists in the List

Parameters:

item -

Returns:

true if the item is found and the associated item widget removed

removeAllItems

public void removeAllItems()

Remove all items

getItemWidget

public Widget getItemWidget(DataProvider item)

Parameters:

item -

Returns:

The item Widget associated with the specified DataProvider. If no item is found null is returned

processItemsModelUpdateEvent

public boolean processItemsModelUpdateEvent(byte type,
                                            java.lang.String property,
                                            DataProvider item,
                                            LinkedListEnumeration itemsEnumeration)

Description copied from class: Widget

Process an items model update event.

Overrides:

processItemsModelUpdateEvent in class Widget

Returns:

true if the event is treated by the widget