qx.ui.form
Class List

java.lang.Object
  qx.core.Object
      qx.core.Target
          qx.ui.core.Widget
              qx.ui.core.Parent
                  qx.ui.layout.BoxLayout
                      qx.ui.layout.VerticalBoxLayout
                          qx.ui.form.List

public class List
extends VerticalBoxLayout

Field Summary

Fields inherited from class qx.ui.core.Widget

AUTO

Constructor Summary

List()

Method Summary

java.lang.Object	_findItem(java.lang.String vUserValue, int vStartIndex, java.lang.String vType) Executes different (depending on the given search type) methods of qx.ui.form.ListItem for searching the given search string.
void	_onclick(MouseEvent e) Delegates the event to the selection manager if a list item could be resolved out of the event target.
void	_ondblclick(MouseEvent e) Delegates the event to the selection manager if a list item could be resolved out of the event target.
void	_onkeydown(KeyEvent e) Dispatches the “action” event on every selected list item when the “Enter” key is pressed
void	_onkeyinput(KeyEvent e) Handles the inline find – if enabled
void	_onkeypress(KeyEvent e) Delegates the control of the event to selection manager
void	_onmousedown(MouseEvent e) Delegates the event to the selection manager if a list item could be resolved out of the event target.
void	_onmouseover(MouseEvent e) Delegates the event to the selection manager if a list item could be resolved out of the event target.
void	_onmouseup(MouseEvent e) Delegates the event to the selection manager if a list item could be resolved out of the event target.
int	_sortItemsCompare(java.lang.Object a, java.lang.Object b) Compare method called by the sort method
java.lang.Object	findString(java.lang.String vText, int vStartIndex) Perform a search for a string
java.lang.Object	findStringExact(java.lang.String vText, int vStartIndex) Perform a exact search for a string
java.lang.Object	findValue(java.lang.String vText, int vStartIndex) Perform a search for a value
java.lang.Object	findValueExact(java.lang.String vText, int vStartIndex) Perform a exact search for a value
boolean	getEnableInlineFind() Returns the (computed) value of the property enableInlineFind.
ListItem	getListItemTarget(java.lang.Object vItem) Traverses the widget tree upwards until a corresponding qx.ui.form.ListItem to given vItem (event target) is found.
SelectionManager	getManager() Accessor method for the selection manager
boolean	getMarkLeadingItem() Returns the (computed) value of the property markLeadingItem.
java.lang.Object	getSelectedItem() Returns the first selected list item.
java.lang.Object	getSelectedItems() Returns all selected list items (uses the selection manager).
void	initEnableInlineFind(boolean arg) Calls the apply method and dispatches the change event of the property enableInlineFind with the default value defined by the class developer.
void	initMarkLeadingItem(boolean arg) Calls the apply method and dispatches the change event of the property markLeadingItem with the default value defined by the class developer.
boolean	isEnableInlineFind() Check whether the (computed) value of the boolean property enableInlineFind equals true.
boolean	isMarkLeadingItem() Check whether the (computed) value of the boolean property markLeadingItem equals true.
void	resetEnableInlineFind() Resets the user value of the property enableInlineFind.
void	resetMarkLeadingItem() Resets the user value of the property markLeadingItem.
void	setEnableInlineFind(boolean arg) Sets the user value of the property enableInlineFind.
void	setMarkLeadingItem(boolean arg) Sets the user value of the property markLeadingItem.
void	sortItemsByString(boolean vReverse) Sorts all items by using the string of the label.
void	sortItemsByValue(boolean vReverse) Sorts all items by using the value.
boolean	toggleEnableInlineFind() Toggles the (computed) value of the boolean property enableInlineFind.
boolean	toggleMarkLeadingItem() Toggles the (computed) value of the boolean property markLeadingItem.

Methods inherited from class qx.ui.layout.BoxLayout

_applyHorizontalChildrenAlign, _applyOrientation, _applyReverseChildrenOrder, _applySpacing, _applyStretchChildrenOrthogonalAxis, _applyUseAdvancedFlexAllocation, _applyVerticalChildrenAlign, _computeAccumulatedChildrenOuterHeight, _computeAccumulatedChildrenOuterWidth, _createLayoutImpl, _doLayout, _doLayoutOrder, _invalidateLayoutMode, _recomputeChildrenStretchingX, _recomputeChildrenStretchingY, _updateLayoutMode, getHorizontalChildrenAlign, getLayoutMode, getOrientation, getReverseChildrenOrder, getSpacing, getStretchChildrenOrthogonalAxis, getUseAdvancedFlexAllocation, getVerticalChildrenAlign, initHorizontalChildrenAlign, initOrientation, initReverseChildrenOrder, initSpacing, initStretchChildrenOrthogonalAxis, initUseAdvancedFlexAllocation, initVerticalChildrenAlign, isHorizontal, isReverseChildrenOrder, isStretchChildrenOrthogonalAxis, isUseAdvancedFlexAllocation, isVertical, resetHorizontalChildrenAlign, resetOrientation, resetReverseChildrenOrder, resetSpacing, resetStretchChildrenOrthogonalAxis, resetUseAdvancedFlexAllocation, resetVerticalChildrenAlign, setHorizontalChildrenAlign, setOrientation, setReverseChildrenOrder, setSpacing, setStretchChildrenOrthogonalAxis, setUseAdvancedFlexAllocation, setVerticalChildrenAlign, toggleReverseChildrenOrder, toggleStretchChildrenOrthogonalAxis, toggleUseAdvancedFlexAllocation

Methods inherited from class qx.ui.core.Parent

_addChildrenToLayoutQueue, _addChildrenToStateQueue, _addChildToChildrenQueue, _afterAppear, _afterDisappear, _afterInsertDom, _afterRemoveDom, _applyActiveChild, _applyFocusedChild, _applyFocusHandler, _beforeAppear, _beforeDisappear, _beforeInsertDom, _beforeRemoveDom, _changeInnerHeight, _changeInnerWidth, _computePreferredInnerHeight, _computePreferredInnerWidth, _computeVisibleChildren, _flushChildrenQueue, _handleDisplayableCustom, _layoutChild, _layoutPost, _onfocuskeyevent, _recursiveAppearanceThemeUpdate, _removeChildFromChildrenQueue, activateFocusRoot, add, addAfter, addAt, addAtBegin, addAtEnd, addBefore, contains, forEachChild, forEachVisibleChild, getActiveChild, getChildren, getChildrenLength, getFirstActiveChild, getFirstChild, getFirstVisibleChild, getFocusedChild, getFocusHandler, getFocusRoot, getInnerHeightForChild, getInnerWidthForChild, getLastActiveChild, getLastChild, getLastVisibleChild, getLayoutImpl, getVisibleChildrenLength, hasChildren, hasVisibleChildren, indexOf, initActiveChild, initFocusedChild, initFocusHandler, isEmpty, isFocusRoot, isVisibleEmpty, recursiveAddToStateQueue, remapChildrenHandlingTo, remove, removeAll, removeAt, resetActiveChild, resetFocusedChild, resetFocusHandler, setActiveChild, setFocusedChild, setFocusHandler

Methods inherited from class qx.ui.core.Widget

_applyAppearance, _applyBackgroundColor, _applyBackgroundImage, _applyBackgroundRepeat, _applyBorder, _applyBottom, _applyCapture, _applyClip, _applyCommand, _applyCursor, _applyDisplay, _applyElement, _applyElementData, _applyEnabled, _applyFocused, _applyFont, _applyHeight, _applyHideFocus, _applyHtmlAttributes, _applyHtmlProperties, _applyLeft, _applyMarginBottom, _applyMarginLeft, _applyMarginRight, _applyMarginTop, _applyMaxHeight, _applyMaxWidth, _applyMinHeight, _applyMinWidth, _applyOpacity, _applyOverflow, _applyPaddingBottom, _applyPaddingLeft, _applyPaddingRight, _applyPaddingTop, _applyParent, _applyRight, _applySelectable, _applyStateStyleFocus, _applyStyleProperties, _applyTabIndex, _applyTextColor, _applyTop, _applyVisibility, _applyWidth, _applyZIndex, _checkParent, _compileClipString, _computeBoxHeight, _computeBoxHeightFallback, _computeBoxWidth, _computeBoxWidthFallback, _computeDisplayable, _computeFrameHeight, _computeFrameWidth, _computeHasAutoX, _computeHasAutoY, _computeHasFlexX, _computeHasFlexY, _computeHasPercentX, _computeHasPercentY, _computeInnerHeight, _computeInnerWidth, _computeOuterHeight, _computeOuterWidth, _computePreferredBoxHeight, _computePreferredBoxWidth, _computeValuePercentX, _computeValuePercentXLimit, _computeValuePercentY, _computeValuePercentYLimit, _computeValuePixel, _computeValuePixelLimit, _createElementImpl, _evalUnitsPixelPercent, _evalUnitsPixelPercentAuto, _evalUnitsPixelPercentAutoFlex, _flushJobQueue, _generateHtmlId, _getTargetNode, _handleDisplayable, _invalidateFrameDimensions, _invalidatePreferredInnerDimensions, _queueBorder, _recomputeFlexX, _recomputeFlexY, _recomputePercentX, _recomputePercentY, _recomputeRangeX, _recomputeRangeY, _recomputeStretchingX, _recomputeStretchingY, _renderAppearance, _renderOverflow, _resetAppearanceThemeWrapper, _styleBackgroundColor, _styleBackgroundImage, _styleFromMap, _unitDetectionPixelPercent, _unitDetectionPixelPercentAuto, _unitDetectionPixelPercentAutoFlex, _unstyleFromArray, _visualizeBlur, _visualizeFocus, _visualPropertyCheck, addState, addToDocument, addToJobQueue, addToLayoutChanges, addToQueue, addToQueueRuntime, addToStateQueue, auto, blur, connect, contains, disconnect, execute, focus, getAllowStretchX, getAllowStretchY, getAnonymous, getAppearance, getBackgroundColor, getBackgroundImage, getBackgroundRepeat, getBorder, getBottom, getBottomValue, getCapture, getClientHeight, getClientWidth, getClipHeight, getClipLeft, getClipTop, getClipWidth, getCommand, getContextMenu, getCursor, getDisplay, getDropDataTypes, getElement, getEnabled, getEnableElementFocus, getFocused, getFont, getHeight, getHeightValue, getHideFocus, getHorizontalAlign, getHtmlAttribute, getHtmlProperty, getLeft, getLeftValue, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMaxHeight, getMaxHeightValue, getMaxWidth, getMaxWidthValue, getMinHeight, getMinHeightValue, getMinWidth, getMinWidthValue, getNeededHeight, getNeededWidth, getNextActiveSibling, getNextSibling, getNextVisibleSibling, getOffsetHeight, getOffsetLeft, getOffsetTop, getOffsetWidth, getOpacity, getOverflow, getOverflowX, getOverflowY, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getParent, getPreviousActiveSibling, getPreviousSibling, getPreviousVisibleSibling, getRight, getRightValue, getScrollHeight, getScrollLeft, getScrollTop, getScrollWidth, getSelectable, getStyleProperty, getSupportsDropMethod, getTabIndex, getTextColor, getToolTip, getTop, getTopLevelWidget, getTopValue, getVerticalAlign, getVisibility, getVisibleChildren, getWidth, getWidthValue, getZIndex, hasState, hide, indexOf, initAllowStretchX, initAllowStretchY, initAnonymous, initAppearance, initBackgroundColor, initBackgroundImage, initBackgroundRepeat, initBorder, initBottom, initCapture, initClipHeight, initClipLeft, initClipTop, initClipWidth, initCommand, initContextMenu, initCursor, initDisplay, initDropDataTypes, initElement, initEnabled, initEnableElementFocus, initFocused, initFont, initHeight, initHideFocus, initHorizontalAlign, initLeft, initMarginBottom, initMarginLeft, initMarginRight, initMarginTop, initMaxHeight, initMaxWidth, initMinHeight, initMinWidth, initOpacity, initOverflow, initPaddingBottom, initPaddingLeft, initPaddingRight, initPaddingTop, initParent, initRight, initSelectable, initSupportsDropMethod, initTabIndex, initTextColor, initToolTip, initTop, initVerticalAlign, initVisibility, initWidth, initZIndex, isAllowStretchX, isAllowStretchY, isAnonymous, isAppearRelevant, isCapture, isCreated, isDisplay, isDisplayable, isEnabled, isEnableElementFocus, isFirstChild, isFirstVisibleChild, isFocusable, isFocused, isHideFocus, isLastChild, isLastVisibleChild, isMaterialized, isSeeable, isSelectable, isVisibility, moveSelfAfter, moveSelfBefore, moveSelfToBegin, moveSelfToEnd, pack, removeHtmlAttribute, removeHtmlProperty, removeState, removeStyleProperty, renderPadding, resetAlign, resetAllowStretchX, resetAllowStretchY, resetAnonymous, resetAppearance, resetBackgroundColor, resetBackgroundImage, resetBackgroundRepeat, resetBorder, resetBottom, resetCapture, resetClip, resetClipDimension, resetClipHeight, resetClipLeft, resetClipLocation, resetClipTop, resetClipWidth, resetCommand, resetContextMenu, resetCursor, resetDimension, resetDisplay, resetDropDataTypes, resetEdge, resetElement, resetEnabled, resetEnableElementFocus, resetFocused, resetFont, resetHeight, resetHeights, resetHideFocus, resetHorizontalAlign, resetLeft, resetLocation, resetMargin, resetMarginBottom, resetMarginLeft, resetMarginRight, resetMarginTop, resetMaxHeight, resetMaxWidth, resetMinHeight, resetMinWidth, resetOpacity, resetOverflow, resetPadding, resetPaddingBottom, resetPaddingLeft, resetPaddingRight, resetPaddingTop, resetParent, resetRight, resetSelectable, resetSpace, resetSupportsDropMethod, resetTabIndex, resetTextColor, resetToolTip, resetTop, resetVerticalAlign, resetVisibility, resetWidth, resetWidths, resetZIndex, scrollIntoView, scrollIntoViewX, scrollIntoViewY, setAlign, setAllowStretchX, setAllowStretchY, setAnonymous, setAppearance, setBackgroundColor, setBackgroundImage, setBackgroundRepeat, setBorder, setBottom, setCapture, setClip, setClipDimension, setClipHeight, setClipLeft, setClipLocation, setClipTop, setClipWidth, setCommand, setContextMenu, setCursor, setDimension, setDisplay, setDropDataTypes, setEdge, setElement, setEnabled, setEnableElementFocus, setFocused, setFont, setHeight, setHeights, setHideFocus, setHorizontalAlign, setHtmlAttribute, setHtmlProperty, setLeft, setLocation, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setOpacity, setOverflow, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setParent, setRight, setScrollLeft, setScrollTop, setSelectable, setSpace, setStyleProperty, setSupportsDropMethod, setTabIndex, setTextColor, setToolTip, setTop, setVerticalAlign, setVisibility, setWidth, setWidths, setZIndex, show, supportsDrop, toggleAllowStretchX, toggleAllowStretchY, toggleAnonymous, toggleCapture, toggleDisplay, toggleEnabled, toggleEnableElementFocus, toggleFocused, toggleHideFocus, toggleSelectable, toggleVisibility

Methods inherited from class qx.core.Target

_dispatchEvent, addChangeSelectionListener, addChangeValueListener, addEventListener, addExecuteListener, addJavaEventListener, createDispatchChangeEvent, createDispatchDataEvent, createDispatchEvent, dispatchEvent, hasEventListeners, removeEventListener

Methods inherited from class qx.core.Object

_disposeFields, _disposeObjectDeep, _disposeObjects, base, dispose, get, getDisposed, isDisposed, reset, self, set, toHashCode, toString_

Methods inherited from class java.lang.Object

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

Constructor Detail

List

public List()

Method Detail

_findItem

public java.lang.Object _findItem(java.lang.String vUserValue,
                                  int vStartIndex,
                                  java.lang.String vType)

Executes different (depending on the given search type) methods of qx.ui.form.ListItem for searching the given search string. Returns a reference to the qx.ui.form.ListItem where the search string is found first.

_onclick

public void _onclick(MouseEvent e)

Delegates the event to the selection manager if a list item could be resolved out of the event target.

_ondblclick

public void _ondblclick(MouseEvent e)

Delegates the event to the selection manager if a list item could be resolved out of the event target.

_onkeydown

public void _onkeydown(KeyEvent e)

Dispatches the “action” event on every selected list item when the “Enter” key is pressed

_onkeyinput

public void _onkeyinput(KeyEvent e)

Handles the inline find – if enabled

_onkeypress

public void _onkeypress(KeyEvent e)

Delegates the control of the event to selection manager

_onmousedown

public void _onmousedown(MouseEvent e)

Delegates the event to the selection manager if a list item could be resolved out of the event target.

_onmouseover

public void _onmouseover(MouseEvent e)

Delegates the event to the selection manager if a list item could be resolved out of the event target.

_onmouseup

public void _onmouseup(MouseEvent e)

Delegates the event to the selection manager if a list item could be resolved out of the event target.

_sortItemsCompare

public int _sortItemsCompare(java.lang.Object a,
                             java.lang.Object b)

Compare method called by the sort method

findString

public java.lang.Object findString(java.lang.String vText,
                                   int vStartIndex)

Perform a search for a string

findStringExact

public java.lang.Object findStringExact(java.lang.String vText,
                                        int vStartIndex)

Perform a exact search for a string

findValue

public java.lang.Object findValue(java.lang.String vText,
                                  int vStartIndex)

Perform a search for a value

findValueExact

public java.lang.Object findValueExact(java.lang.String vText,
                                       int vStartIndex)

Perform a exact search for a value

getEnableInlineFind

public boolean getEnableInlineFind()

Returns the (computed) value of the property enableInlineFind.

For further details take a look at the property definition: enableInlineFind.

getListItemTarget

public ListItem getListItemTarget(java.lang.Object vItem)

Traverses the widget tree upwards until a corresponding qx.ui.form.ListItem to given vItem (event target) is found.

getManager

public SelectionManager getManager()

Accessor method for the selection manager

getMarkLeadingItem

public boolean getMarkLeadingItem()

Returns the (computed) value of the property markLeadingItem.

For further details take a look at the property definition: markLeadingItem.

getSelectedItem

public java.lang.Object getSelectedItem()

Returns the first selected list item.

getSelectedItems

public java.lang.Object getSelectedItems()

Returns all selected list items (uses the selection manager).

initEnableInlineFind

public void initEnableInlineFind(boolean arg)

Calls the apply method and dispatches the change event of the property enableInlineFind with the default value defined by the class developer. This function can only be called from the constructor of a class.

For further details take a look at the property definition: enableInlineFind.

initMarkLeadingItem

public void initMarkLeadingItem(boolean arg)

Calls the apply method and dispatches the change event of the property markLeadingItem with the default value defined by the class developer. This function can only be called from the constructor of a class.

For further details take a look at the property definition: markLeadingItem.

isEnableInlineFind

public boolean isEnableInlineFind()

Check whether the (computed) value of the boolean property enableInlineFind equals true.

For further details take a look at the property definition: enableInlineFind.

isMarkLeadingItem

public boolean isMarkLeadingItem()

Check whether the (computed) value of the boolean property markLeadingItem equals true.

For further details take a look at the property definition: markLeadingItem.

resetEnableInlineFind

public void resetEnableInlineFind()

Resets the user value of the property enableInlineFind.

The computed value falls back to the next available value e.g. appearance, init or inheritance value depeneding on the property configuration and value availability.

For further details take a look at the property definition: enableInlineFind.

resetMarkLeadingItem

public void resetMarkLeadingItem()

Resets the user value of the property markLeadingItem.

The computed value falls back to the next available value e.g. appearance, init or inheritance value depeneding on the property configuration and value availability.

For further details take a look at the property definition: markLeadingItem.

setEnableInlineFind

public void setEnableInlineFind(boolean arg)

Sets the user value of the property enableInlineFind.

For further details take a look at the property definition: enableInlineFind.

setMarkLeadingItem

public void setMarkLeadingItem(boolean arg)

Sets the user value of the property markLeadingItem.

For further details take a look at the property definition: markLeadingItem.

sortItemsByString

public void sortItemsByString(boolean vReverse)

Sorts all items by using the string of the label.

sortItemsByValue

public void sortItemsByValue(boolean vReverse)

Sorts all items by using the value.

toggleEnableInlineFind

public boolean toggleEnableInlineFind()

Toggles the (computed) value of the boolean property enableInlineFind.

For further details take a look at the property definition: enableInlineFind.

toggleMarkLeadingItem

public boolean toggleMarkLeadingItem()

Toggles the (computed) value of the boolean property markLeadingItem.

For further details take a look at the property definition: markLeadingItem.