de.enough.polish.ui
Class TreeItem

java.lang.Object
  javax.microedition.lcdui.Item
      javax.microedition.lcdui.CustomItem
          de.enough.polish.ui.FakeCustomItem
              de.enough.polish.ui.FakeContainerCustomItem
                  de.enough.polish.ui.TreeItem

public class TreeItem
extends FakeContainerCustomItem

Provides a tree of items that can contain several branches.

Each tree branch behaves like a normal J2ME Polish container, so you can specify view-types, columns, colspans, etc.

Copyright (c) Enough Software 2005 - 2009

 history
        16-Feb-2005 - rob creation
 

Author:

Robert Virkus, j2mepolish@enough.de

Field Summary

ArrayList

treeModelChildrenList

Fields inherited from class de.enough.polish.ui.FakeContainerCustomItem

allowCycling, autoFocusEnabled, autoFocusIndex, containerView, enableScrolling, focusAllStyle, focusedIndex, focusedItem, focusedStyleFirst, focusedStyleLast, isExpandItems, itemsList, itemStyle, lastPointerPressTime, lastPointerPressY, lastPointerPressYOffset, plainStyle, SCROLL_DEFAULT, SCROLL_SMOOTH, scrollHeight, scrollSmooth, targetYOffset, yOffset

Fields inherited from class de.enough.polish.ui.FakeCustomItem

_bbField, appearanceMode, availableHeight, availableWidth, availContentHeight, availContentWidth, background, backgroundHeight, backgroundWidth, backgroundYOffset, beforeWidth, bgBorder, border, BUTTON, cacheItemImage, colSpan, commands, completeBackground, completeBackgroundPadding, completeBorder, contentHeight, contentWidth, contentX, contentXAdjustment, contentY, contentYAdjustment, cssHeight, cssSelector, cssWidth, defaultCommand, focusedStyle, HORIZONTAL, HYPERLINK, ignoreRepaintRequests, includeLabel, INTERACTIVE, internalHeight, internalWidth, internalX, internalY, isContentVisible, isFocused, isInlineLabel, isInvisible, isLayoutCenter, isLayoutExpand, isLayoutRight, isPressed, isShown, isStyleInitialised, itemCommandListener, itemHeight, itemWidth, label, labelStyle, landscapeStyle, layout, LAYOUT_2, LAYOUT_BOTTOM, LAYOUT_CENTER, LAYOUT_DEFAULT, LAYOUT_EXPAND, LAYOUT_LEFT, LAYOUT_NEWLINE_AFTER, LAYOUT_NEWLINE_BEFORE, LAYOUT_RIGHT, LAYOUT_SHRINK, LAYOUT_TOP, LAYOUT_VCENTER, LAYOUT_VEXPAND, LAYOUT_VSHRINK, marginBottom, marginLeft, marginRight, marginTop, maximumHeight, maximumItemHeight, maximumItemWidth, maximumWidth, minimumHeight, minimumItemHeight, minimumItemWidth, minimumWidth, nativeItem, NO_POSITION_SET, opacity, opacityPaintNormally, opacityRgbData, paddingBottom, paddingHorizontal, paddingLeft, paddingRight, paddingTop, paddingVertical, parent, PLAIN, portraitStyle, preferredHeight, preferredWidth, preserveViewType, relativeX, relativeY, rowSpan, screen, setView, style, TRANSPARENT, useSingleRow, VERTICAL, view, xAdjustment, yAdjustment

Fields inherited from class javax.microedition.lcdui.CustomItem

KEY_PRESS, KEY_RELEASE, KEY_REPEAT, NONE, POINTER_DRAG, POINTER_PRESS, POINTER_RELEASE, TRAVERSE_HORIZONTAL, TRAVERSE_VERTICAL

Constructor Summary

TreeItem(String label)
Creates a new tree item.

TreeItem(String label, Style style)
Creates a new tree item.

TreeItem(String label, TreeModel model)
Creates a new tree item.

TreeItem(String label, TreeModel model, Style style)
Creates a new tree item.

Method Summary

void	appendToNode(Item node, Item item) Adds the specified item to this tree.
void	appendToNode(Item node, Item item) Adds the specified item to this tree.
void	appendToNode(Item node, Item item, Style childStyle) Adds the specified item to this tree.
Item	appendToNode(Item node, String text, Image image) Adds the specified text/image to this tree.
Item	appendToNode(Item node, String text, Image image) Adds the specified text/image to this tree.
Item	appendToNode(Item node, String text, Image image, Style childStyle) Adds the specified text/image to this tree.
void	appendToRoot(Item item) Adds the specified item to this tree.
void	appendToRoot(Item item) Adds the specified item to this list.
void	appendToRoot(Item item, Style childStyle) Adds the specified item to this list.
Item	appendToRoot(String text, Image image) Appends the specified text and image to this list.
Item	appendToRoot(String text, Image image, Style rootStyle) Appends the specified text and image to this list and provides it with the given style.
void	collapseAll() Collapses all branches of this TreeItem.
protected de.enough.polish.ui.TreeItem.Node	convertToNode(Item treeElement) Converts a TreeItem into a node (if not realized before)
protected Style	focus(Style focusStyle, int direction) Focuses this item.
Item[]	getSelectedPath() Retrieves the currently selected path of this tree item.
Object[]	getSelectedPathAsAttributes(Object key) Retrieves the currently selected path of this tree item.
boolean	remove(Item item) Removes the specified item from this list.
void	removeAll() Clears this list.
void	setSelectedPathByAttribute(Object key, Object[] values) Opens the tree and focuses the specified items.
void	setStyle(Style style) Sets the style of this item.

Methods inherited from class de.enough.polish.ui.FakeContainerCustomItem

add, add, add, add, add, add, add, addRepaintArea, animate, changeChildStyles, changeChildStyles, clear, contains, createCssSelector, defocus, destroy, fireEvent, focusChild, focusChild, focusClosestItem, focusClosestItemAbove, get, getChildAt, getChildAtImpl, getChildHeight, getChildWidth, getCurrentScrollYOffset, getFocusedChild, getFocusedIndex, getFocusedItem, getFocusedStyle, getFocusListener, getInternalArray, getItemAreaHeight, getItemAt, getItems, getNumberOfInteractiveItems, getPosition, getRelativeScrollYOffset, getScrollHeight, getScrollYOffset, getSynchronizationLock, getView, getView, handleCommand, handleKeyPressed, handleKeyReleased, handleKeyRepeated, handleNavigate, handlePointerDragged, handlePointerDragged, handlePointerPressed, handlePointerReleased, handlePointerScrollReleased, handlePointerTouchDown, handlePointerTouchUp, hideNotify, indexOf, initContent, initLayout, initMargin, isInItemArea, isScrolling, notifyItemPressedEnd, notifyItemPressedStart, onScreenSizeChanged, paintBackgroundAndBorder, paintContent, parseIndexUrl, releaseResources, remove, remove, requestDefocus, requestFullInit, scroll, scroll, scroll, set, set, set, setAppearanceMode, setContentHeight, setContentWidth, setFocusListener, setItemsList, setItemWidth, setScrollHeight, setScrollYOffset, setScrollYOffset, setStyle, setStyleWithBackground, setView, showCommands, showNotify, size, startScroll, toString, updateInternalPosition

Methods inherited from class de.enough.polish.ui.FakeCustomItem

addCommand, addCommand, addCommand, addCommands, addRelativeToBackgroundRegion, addRelativeToBackgroundRegion, addRelativeToContentRegion, animate, containsCommand, getAbsoluteX, getAbsoluteY, getAppearanceMode, getAttribute, getAttributes, getAvailableContentHeight, getAvailableContentWidth, getAvailableHeight, getAvailableWidth, getBackgroundHeight, getBackgroundWidth, getBackgroundX, getBackgroundY, getBorderWidthBottom, getBorderWidthLeft, getBorderWidthRight, getBorderWidthTop, getContentHeight, getContentWidth, getContentX, getContentY, getDefaultCommand, getFocusedStyle, getInternalHeight, getInternalWidth, getInternalX, getInternalY, getItemCommandListener, getItemCommands, getItemHeight, getItemHeight, getItemStateListener, getItemWidth, getItemWidth, getLabel, getLabelItem, getLayout, getMaximumHeight, getMaximumHeight, getMaximumWidth, getMaximumWidth, getMinContentHeight, getMinContentWidth, getMinimumHeight, getMinimumHeight, getMinimumWidth, getMinimumWidth, getNativeItem, getParent, getPrefContentHeight, getPrefContentWidth, getpreferredHeight, getpreferredWidth, getRgbData, getRgbData, getScreen, getStyle, getUiEventListener, handleCommand, handleGesture, handleGestureHold, handleGestureSwipeLeft, handleGestureSwipeRight, init, initPadding, initStyle, isFocused, isInContentArea, isInContentWithPaddingArea, isInItemArea, isInitialized, isInteractive, isLayoutBottom, isLayoutCenter, isLayoutExpand, isLayoutLeft, isLayoutNewlineAfter, isLayoutNewlineBefore, isLayoutRight, isLayoutShrink, isLayoutTop, isLayoutVerticalCenter, isLayoutVerticalExpand, isLayoutVerticalShrink, isPressed, isVisible, notifyStateChanged, notifyUnvisited, notifyValueChanged, notifyVisited, paint, paint, paintBackground, paintBorder, paintCommands, paintFilter, removeAttribute, removeCommand, repaintFully, requestInit, setAbsoluteY, setAttribute, setBackground, setBorder, setDefaultCommand, setDefaultCommand, setInitialized, setItemCommandListener, setItemCommandListener, setItemHeight, setItemStateListener, setItemTransition, setLabel, setLayout, setNativeItem, setParent, setParent, setpreferredSize, setStyle, setUiEventListener, setVisible, show, toImage, toRgbImage, updateInternalArea

Methods inherited from class javax.microedition.lcdui.CustomItem

getGameAction, getInteractionModes, invalidate, keyPressed, keyReleased, keyRepeated, pointerDragged, pointerPressed, pointerReleased, repaint, repaint, sizeChanged, traverse, traverseOut

Methods inherited from class javax.microedition.lcdui.Item

getPreferredHeight, getPreferredWidth, removeCommand, setPreferredSize

Methods inherited from class java.lang.Object

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

Field Detail

treeModelChildrenList

public ArrayList treeModelChildrenList

Constructor Detail

TreeItem

public TreeItem(String label)

Creates a new tree item.

Parameters:

label - the label of this item

TreeItem

public TreeItem(String label,
                Style style)

Creates a new tree item.

Parameters:

label - the label of this item

style - the style

TreeItem

public TreeItem(String label,
                TreeModel model)

Creates a new tree item.

Parameters:

label - the label of this item

model - the data model for this tree

TreeItem

public TreeItem(String label,
                TreeModel model,
                Style style)

Creates a new tree item.

Parameters:

label - the label of this item

model - the data model for this tree

style - the style

Method Detail

appendToRoot

public void appendToRoot(Item item)

Adds the specified item to this tree.

Parameters:

item - the item that should be added

appendToNode

public void appendToNode(Item node,
                         Item item)

Adds the specified item to this tree.

Parameters:

node - the parent node that has been previously added to this tree

item - the item that should be added

appendToNode

public Item appendToNode(Item node,
                         String text,
                         Image image)

Adds the specified text/image to this tree.

Parameters:

node - the parent node that has been previously added to this tree

text - the text

image - the image

Returns:

the created item

remove

public boolean remove(Item item)

Removes the specified item from this list.

Parameters:

item - the item that should be removed

Returns:

true when the item was contained in this list.

appendToRoot

public Item appendToRoot(String text,
                         Image image)

Appends the specified text and image to this list.

Parameters:

text - the text

image - the image

Returns:

the created item

appendToRoot

public Item appendToRoot(String text,
                         Image image,
                         Style rootStyle)

Appends the specified text and image to this list and provides it with the given style.

Parameters:

text - the text

image - the image

rootStyle - the style

Returns:

return the created item

appendToRoot

public void appendToRoot(Item item)

Adds the specified item to this list.

Parameters:

item - the item that should be added

appendToRoot

public void appendToRoot(Item item,
                         Style childStyle)

Adds the specified item to this list.

Parameters:

item - the item that should be added

childStyle - the style

appendToNode

public Item appendToNode(Item node,
                         String text,
                         Image image)

Adds the specified text/image to this tree.

Parameters:

node - the parent node that has been previously added to this tree

text - the text

image - the image

Returns:

the created item

appendToNode

public Item appendToNode(Item node,
                         String text,
                         Image image,
                         Style childStyle)

Adds the specified text/image to this tree.

Parameters:

node - the parent node that has been previously added to this tree

text - the text

image - the image

childStyle - the style

Returns:

the created item

appendToNode

public void appendToNode(Item node,
                         Item item)

Adds the specified item to this tree.

Parameters:

node - the parent node that has been previously added to this tree

item - the item that should be added

convertToNode

protected de.enough.polish.ui.TreeItem.Node convertToNode(Item treeElement)

Converts a TreeItem into a node (if not realized before)

Parameters:

treeElement - an item within this tree

Returns:

the parent node for the the TreeItem

appendToNode

public void appendToNode(Item node,
                         Item item,
                         Style childStyle)

Adds the specified item to this tree.

Parameters:

node - the parent node that has been previously added to this tree

item - the item that should be added

childStyle - the style

removeAll

public void removeAll()

Clears this list.

setStyle

public void setStyle(Style style)

Description copied from class: FakeCustomItem

Sets the style of this item.

Overrides:

setStyle in class FakeContainerCustomItem

Parameters:

style - the new style for this item.

getSelectedPath

public Item[] getSelectedPath()

Retrieves the currently selected path of this tree item.

Returns:

an array that contains all selected items

getSelectedPathAsAttributes

public Object[] getSelectedPathAsAttributes(Object key)

Retrieves the currently selected path of this tree item.

Parameters:

key - the key that is used for querying attributes from the focused item

Returns:

an array that contains all attribute values of the selected items. When an item has not registered the specified attribute, the item itself will be put into that array slot.

See Also:

UiAccess.setAttribute(Item, Object, Object), UiAccess.getAttribute(Item, Object)

setSelectedPathByAttribute

public void setSelectedPathByAttribute(Object key,
                                       Object[] values)

Opens the tree and focuses the specified items. All other branches are collapsed while the specified path(s) is opened. When several paths do match, the last matching path is focused.

Parameters:

key - the attribute key

values - the values that are set for each item / node

See Also:

UiAccess.setAttribute(Item, Object, Object), UiAccess.getAttribute(Item, Object)

focus

protected Style focus(Style focusStyle,
                      int direction)

Description copied from class: FakeCustomItem

Focuses this item.

Overrides:

focus in class FakeContainerCustomItem

Parameters:

focusStyle - the style which is used to indicate the focused state

direction - the direction from which this item is focused, either Canvas.UP, Canvas.DOWN, Canvas.LEFT, Canvas.RIGHT or 0. When 0 is given, the direction is unknown.

Returns:

the current style of this item

collapseAll

public void collapseAll()

Collapses all branches of this TreeItem.