com.swfm.mica.widgets
Class MiTreeList

java.lang.Object
  extended bycom.swfm.mica.core.MiPart
      extended bycom.swfm.mica.core.MiContainer
          extended bycom.swfm.mica.layouts.MiLayout
              extended bycom.swfm.mica.core.MiVisibleContainer
                  extended bycom.swfm.mica.widgets.MiWidget
                      extended bycom.swfm.mica.widgets.MiTable
                          extended bycom.swfm.mica.widgets.MiTreeList
All Implemented Interfaces:
MiiActionTypes, MiiAdjustableGrid, MiiAttributeTypes, MiiBackgroundableGrid, MiiCopyable, MiiDragAndDropParticipant, MiiEventTypes, MiiLayout, MiiNames, MiiPropertyTypes, MiiScrollableData, MiiSelectableTableContentSupplier, MiiTypes

public class MiTreeList
extends MiTable

Version:
%I% %G%
Author:
Michael L. Davis

Field Summary
                     
Constructor Summary
MiTreeList()
           
MiTreeList(boolean multipleSelectionsAllowed)
           
MiTreeList(int numVisibleCharactersWide, boolean multipleSelectionsAllowed)
           
MiTreeList(int numVisibleCharactersWide, int numVisibleRows, boolean multipleSelectionsAllowed)
           
 
Method Summary
 boolean activateItem(int index)
           
 void activateItemWithTag(java.lang.Object tag)
           
 void addItem(MiPart label, MiPart image, java.lang.Object tag, java.lang.Object parentsTag, boolean canHaveChildren)
           
 void addItem(MiPart label, MiPart image, java.lang.Object tag, java.lang.Object parentsTag, boolean canHaveChildren, MiTableCells cells)
           
 void addItem(MiPart label, java.lang.Object tag, java.lang.Object parentsTag, boolean canHaveChildren)
           
 void addItem(java.lang.String label, MiPart image, java.lang.Object tag, java.lang.Object parentsTag, boolean canHaveChildren)
           
 void appendItem(java.lang.String item)
           
 void appendItems(Strings items)
          Appends items by parsing strings of form:
 void changeTagOfItem(java.lang.Object oldTag, java.lang.Object newTag)
           
 void collapse(java.lang.Object tag)
           
 void collapseAll()
           
 void collapseExpandAll(boolean toCollapse)
           
 void collapseExpandAll(int depth, boolean toCollapse)
           
 void collapseExpandAll(java.lang.Object tag, int depth, boolean toCollapse)
           
 MiiTreeListEntry copyItemWithTag(java.lang.Object tag)
           
 MiiTreeListEntry cutItemWithTag(java.lang.Object tag)
           
 void deSelectAll()
           
 void deSelectItem(int index)
           
 void doImport(MiDataTransferOperation transfer)
          Import the data specified by the given data transfer operation.
 void expand(java.lang.Object tag)
           
 void expandAll()
           
 java.lang.Object getChild(java.lang.Object tag, int index)
           
 MiPart getCollapseButton()
           
 Strings getContents()
          Gets the contents (list of values) this widget displays.
 MiPart getExpandButton()
           
 MiPart getIconWithTag(java.lang.Object tag)
           
 int getIndexOfItem(MiPart obj)
          Gets the index of the given item in this container.
 int getIndexOfItem(java.lang.Object tag)
           
 int getIndexOfItem(java.lang.String text)
           
 MiPart getItem(int index)
          Gets the item of this container at the given index.
 boolean getItemCanHaveChildren(java.lang.Object tag)
           
 MiTreeListEntryGraphics getItemWithTag(java.lang.Object tag)
           
 MiPart getLabelWithTag(java.lang.Object tag)
           
 MiAttributes getLineAttributes()
           
 int getNumberOfChildren(java.lang.Object tag)
           
 int getNumberOfItems()
          Gets the number of items this container has.
 int getNumberOfSelectedItems()
           
 int getNumberOfVisibleCharactersWide()
           
 java.lang.Object getParentOfItem(java.lang.Object tag)
           
 MiTreeListEntryGraphics getPartItem(int index)
           
 java.lang.String getSelectedItem()
           
 int getSelectedItemIndex()
           
 int[] getSelectedItemIndexes()
           
 Strings getSelectedItems()
           
 java.lang.Object[] getSelectedItemsTags()
           
 java.lang.Object getSelectedItemTag()
           
 MiPart getSelectedObjectItem()
           
 java.lang.String getStringItem(int index)
           
 java.lang.String getStringWithTag(java.lang.Object tag)
           
 java.lang.Object getTagItem(int index)
           
 java.lang.String getValue()
          Gets the value this widget displays.
 boolean isCollapsed(java.lang.Object tag)
           
 boolean isTextItem(int index)
           
 void pasteItemWithTag(java.lang.Object targetTag, MiiTreeListEntry itemEntry)
           
 void refreshLookAndFeel()
           
 void removeAllItems()
          Removes all items from this container.
 void removeItemWithTag(java.lang.Object tag)
           
 void removeItemWithTagsChildren(java.lang.Object tag)
           
 void renderOverlay(MiRenderer renderer)
           
 boolean selectItem(int index)
           
 void selectItem(java.lang.String item)
           
 void selectItemWithTag(java.lang.Object tag)
           
 void setBackgroundColor(java.awt.Color c)
          Sets the background color.
 void setCollapseButton(MiPart button)
           
 void setContents(Strings contents)
          Sets contents items by parsing strings of form:
 void setExpandButton(MiPart button)
           
 void setIconWithTag(java.lang.Object tag, MiPart icon)
           
 void setIndentation(double width)
           
 void setItemLabel(int index, java.lang.String label)
           
 void setItemLabel(java.lang.Object tag, MiPart label)
           
 void setItemLabel(java.lang.Object tag, java.lang.String label)
           
 void setLabelIndentation(double width)
           
 void setLineAttributes(MiAttributes atts)
           
 void setNumberOfVisibleCharactersWide(int numVisibleCharacters)
           
 void setTagItem(int index, java.lang.Object tag)
           
 void setValue(java.lang.String value)
          Sets the value this widget displays.
 void toggleSelectItem(int index)
           
 void toggleSelectItemWithTag(java.lang.Object tag)
           
 
Methods inherited from class com.swfm.mica.widgets.MiTable
addCell, addCell, addCell, appendColumn, appendItem, appendNonOverlappingContentsCells, appendRow, calcNumberOfVisibleColumns, calcNumberOfVisibleRows, createCellsToFillInAnyGapsCreatedByNewCell, getBackgroundManager, getCell, getCell, getCellBounds, getCellWithTag, getColumnBounds, getColumnCells, getColumnDefaults, getColumnFooterBackground, getColumnFooterMargins, getColumnHeaderBackground, getColumnHeaderMargins, getColumnValues, getColumnWidth, getContentAreaDefaults, getContentsBackground, getContentsBounds, getContentsCells, getContentsMargins, getContextCursor, getContextMenu, getHasFixedTotalNumberOfColumns, getHasFixedTotalNumberOfRows, getHorizontalScrollAlignmentPolicy, getIndexOfItem, getLeftColumnOfLastVisibleScreen, getLeftGravitatesToCellBoundry, getLeftVisibleColumn, getMadeColumnDefaults, getMadeRowDefaults, getMaximumNumberOfVisibleColumns, getMaximumNumberOfVisibleRows, getMinimumColumnWidth, getMinimumNumberOfVisibleColumns, getMinimumNumberOfVisibleRows, getMinimumRowHeight, getNormalizedHorizontalAmountVisible, getNormalizedHorizontalPosition, getNormalizedVerticalAmountVisible, getNormalizedVerticalPosition, getNumberOfCells, getNumberOfColumns, getNumberOfRows, getNumberOfVisibleColumns, getNumberOfVisibleRowAtTopIfBottomRowIsGivenRowNumber, getNumberOfVisibleRows, getOverlayRenderer, getPercentToScrollWhenTopDoesNotGravitateToCellBoundry, getPreferredNumberOfVisibleColumns, getPreferredNumberOfVisibleRows, getPropertyValue, getRowBounds, getRowCells, getRowDefaults, getRowFooterBackground, getRowFooterMargins, getRowHeaderBackground, getRowHeaderMargins, getRowValues, getSectionMargins, getSelectionManager, getSortManager, getStatusHelp, getTableHeaderAndFooterManager, getTableLayout, getTableWideDefaults, getToolHintHelp, getTopGravitatesToCellBoundry, getTopRowOfLastVisibleScreen, getTopVisibleRow, getTotalNumberOfColumns, getTotalNumberOfRows, getVerticalScrollAlignmentPolicy, getVisibleColumnLayoutWidth, getVisibleColumns, getVisibleRowLayoutHeight, getVisibleRows, hasColumnFooters, hasColumnHeaders, hasRowFooters, hasRowHeaders, insertColumn, insertRow, invalidateArea, invalidateArea, isCellIntersectingRowColumn, isCellVisible, isHandlingScrollingDiscreteAmountsLocally, isSelectable, isVisibleCell, makeVisible, moveColumn, moveRow, pickCell, pickCell, pickCellIncludingHeadersAndFooters, pickCells, removeAllCells, removeAllCellsAndHeadersAndFooterCells, removeAllColumnFooters, removeAllColumnHeaders, removeAllRowFooters, removeAllRowHeaders, removeCellsAddedToFillInAnyGapsCreatedByNewCell, removeColumn, removeRow, render, replaceColumn, replaceRow, scrollChunkDown, scrollChunkLeft, scrollChunkRight, scrollChunkUp, scrollLineDown, scrollLineLeft, scrollLineRight, scrollLineUp, scrollPageDown, scrollPageLeft, scrollPageRight, scrollPageUp, scrollToBottom, scrollToLeftSide, scrollToNormalizedHorizontalPosition, scrollToNormalizedVerticalPosition, scrollToRightSide, scrollToTop, setBackgroundManager, setColumnDefaults, setColumnFooterBackground, setColumnFooterMargins, setColumnHeaderBackground, setColumnHeaderMargins, setColumnVisibility, setColumnWidth, setContentAreaDefaults, setContentsBackground, setContentsMargins, setDoubleBufferedScrollEnabled, setHasFixedTotalNumberOfColumns, setHasFixedTotalNumberOfRows, setHeaderAndFooterMargins, setHorizontalScrollAlignmentPolicy, setLeftGravitatesToCellBoundry, setLeftVisibleColumn, setMaximumNumberOfVisibleColumns, setMaximumNumberOfVisibleRows, setMinimumColumnWidth, setMinimumNumberOfVisibleColumns, setMinimumNumberOfVisibleRows, setMinimumRowHeight, setNormalizedHorizontalPosition, setNormalizedVerticalPosition, setOverlayRenderer, setPercentToScrollWhenTopDoesNotGravitateToCellBoundry, setPreferredNumberOfVisibleColumns, setPreferredNumberOfVisibleRows, setPropertyValue, setRowDefaults, setRowFooterBackground, setRowFooterMargins, setRowHeaderBackground, setRowHeaderMargins, setRowHeight, setRowVisibility, setSectionMargins, setSelectionManager, setSortManager, setTableHeaderAndFooterManager, setTableLayout, setTableWideDefaults, setTopGravitatesToCellBoundry, setTopVisibleRow, setTotalNumberOfColumns, setTotalNumberOfRows, setVerticalScrollAlignmentPolicy, setVisibleColumnLayoutWidth, setVisibleRowLayoutHeight, switchColumns, switchColumns, switchRows, useNormalizedPositionForContinuousHorizontalAdjustment, useNormalizedPositionForContinuousVerticalAdjustment
 
Methods inherited from class com.swfm.mica.widgets.MiWidget
copy, doExport, getEnterKeyFocusAttributes, getEnterKeyFocusBackgroundColor, getEnterKeyFocusBorderLook, getEnterKeyFocusColor, getEnterKeyFocusStatusHelp, getInSensitiveAttributes, getInSensitiveBackgroundColor, getInSensitiveBorderLook, getInSensitiveColor, getInSensitiveStatusHelp, getKeyboardFocusAttributes, getKeyboardFocusBackgroundColor, getKeyboardFocusBorderLook, getKeyboardFocusColor, getKeyboardFocusStatusHelp, getMouseFocusAttributes, getMouseFocusBackgroundColor, getMouseFocusBorderLook, getMouseFocusColor, getMouseFocusStatusHelp, getNormalAttributes, getNormalBackgroundColor, getNormalBorderLook, getNormalColor, getNormalStatusHelp, getPropertyDescriptions, getRadioStateEnforcer, getSelectedAttributes, getSelectedBackgroundColor, getSelectedBorderLook, getSelectedColor, getSelectedStatusHelp, getToolkit, getWidgetAttributes, isAutoAttributesEnabled, isDesignTime, select, setAttributes, setAutoAttributesEnabled, setCurrentBackgroundColor, setCurrentColor, setEnterKeyFocus, setEnterKeyFocusAttributes, setEnterKeyFocusBackgroundColor, setEnterKeyFocusBorderLook, setEnterKeyFocusColor, setEnterKeyFocusStatusHelpMessage, setInSensitiveAttributes, setInSensitiveBackgroundColor, setInSensitiveBorderLook, setInSensitiveColor, setInSensitiveStatusHelpMessage, setKeyboardFocus, setKeyboardFocusAttributes, setKeyboardFocusBackgroundColor, setKeyboardFocusBorderLook, setKeyboardFocusColor, setKeyboardFocusStatusHelpMessage, setMouseFocus, setMouseFocusAttributes, setMouseFocusBackgroundColor, setMouseFocusBorderLook, setMouseFocusColor, setMouseFocusStatusHelpMessage, setNormalAttributes, setNormalBackgroundColor, setNormalBorderLook, setNormalColor, setNormalStatusHelpMessage, setPropertyValues, setRadioStateEnforcer, setSelectedAttributes, setSelectedBackgroundColor, setSelectedBorderLook, setSelectedColor, setSelectedStatusHelpMessage, setSensitive, setWidgetAttributes, setWidgetAttributes
 
Methods inherited from class com.swfm.mica.core.MiVisibleContainer
calcMinimumSize, calcPreferredSize, getContainerLayoutSpec, getDisplaysFocusBorder, getInnerBounds, getIntersectionWithLine, getOKToDrawOutsideInnerBounds, getShadowShape, getShape, getTotalMargins, getVisibleContainerAutomaticLayoutEnabled, isShapeShrinkToFitEnabled, pick, setContainerLayoutSpec, setDisplaysFocusBorder, setMargins, setOKToDrawOutsideInnerBounds, setShape, setShape, setShapeShrinkToFitEnabled, setVisibleContainerAutomaticLayoutEnabled
 
Methods inherited from class com.swfm.mica.layouts.MiLayout
determinesPreferredAndMinimumSizes, getAlleyHSpacing, getAlleyMargins, getAlleyVSpacing, getCellMargins, getCellMargins, getElementHJustification, getElementHSizing, getElementVJustification, getElementVSizing, getInsetMargins, getInsetMargins, getLastElementJustification, getTarget, getUniqueElementIndex, getUniqueElementSizing, isEnabled, isIndependantOfTargetPosition, isScalingOfPartsWhenBoundsChangesHandledDuringLayout, layoutParts, makeCopy, setAlleyHSpacing, setAlleySpacing, setAlleyVSpacing, setCellMargins, setCellMargins, setElementHJustification, setElementHSizing, setElementJustification, setElementSizing, setElementVJustification, setElementVSizing, setEnabled, setInsetMargins, setInsetMargins, setLastElementJustification, setScalingOfPartsWhenBoundsChangesHandledDuringLayout, setTarget, setUniqueElementIndex, setUniqueElementSizing, toString
 
Methods inherited from class com.swfm.mica.core.MiContainer
appendPart, containsPart, deepCopy, getIndexOfPart, getKeepConnectionsBelowNodes, getNumberOfParts, getPart, getPart, getSupportedImportFormats, hasEventHandlers, hasValidCachedEventHandlerInfo, insertPart, invalidateCachedEventHandlerInfo, isContainerOf, isContainerOf, isContainerOfWithAttachments, pickDeepListContents, pickObject, removeAllParts, removePart, removePart, setKeepConnectionsBelowNodes, setPart, translate
 
Methods inherited from class com.swfm.mica.core.MiPart
_reCalcBounds, _render, _replaceBounds, _setContainer, _setDrawManager, _setValidatingLayout, appendActionHandler, appendActionHandler, appendActionHandler, appendActionHandler, appendActionHandler, appendAttachment, appendAttachment, appendCommandHandler, appendCommandHandler, appendCommandHandler, appendConnection, appendContainer, appendEventHandler, appendPoint, appendPoint, applyCustomLookAndFeel, containsItem, containsOpaqueRectangles, copy, deleteAllConnections, deleteAllParts, deleteSelf, dispatchAction, dispatchAction, dispatchAction, dispatchActionRequest, dispatchActionRequest, dispatchActionRequest, dispatchEvent, draw, drawNow, drawNow, flip, flip, freeAccessLock, get1DShapeStrokeBackgroundColor, get1DShapeStrokesFilled, getAccessLock, getActionHandler, getActionsGenerated, getActionsLocallyGenerated, getActionsRequestedFromParts, getAfterRenderer, getAlphaCompositeRenderMode, getAnnotationPointManager, getAssociatedParts, getAttachment, getAttachment, getAttachmentMargins, getAttachments, getAttributeLockMask, getAttributePublicMask, getAttributes, getAttributeValue, getBackgroundColor, getBackgroundImage, getBackgroundRenderer, getBackgroundTile, getBalloonHelp, getBeforeRenderer, getBlackColor, getBorderHiliteColor, getBorderHiliteWidth, getBorderLook, getBorderRenderer, getBounds, getBounds, getCenter, getCenter, getCenterOfRotation, getCenterX, getCenterY, getColor, getConnection, getConnectionPointManager, getContainer, getContainerRequestedActions, getContainingEditor, getContainingWindow, getContextMenu, getControlPointManager, getCustomLookAndFeels, getCustomLookAndFeels, getDarkColor, getDeepConnection, getDeepConnection, getDeepConnections, getDeeplyInvalidateAreas, getDefaultAttributes, getDialogHelp, getDoubleBuffer, getDragAndDropBehavior, getDrawBounds, getDrawManager, getEventHandler, getEventHandler, getEventHandlerWithClass, getEventHandlingDisabledByContainer, getEventHandlingEnabled, getFlipped, getFont, getFontHorizontalJustification, getFontPointSize, getFontVerticalJustification, getHasBorderHilite, getHasShadow, getHeight, getID, getIncomingInvalidLayoutNotificationsEnabled, getInnerBounds, getInvalidAreaNotificationsEnabled, getInvalidLayoutNotificationsEnabled, getItem, getKeyFocusTraversalGroup, getLayout, getLayoutManipulator, getLightColor, getLineEndSize, getLineEndsRenderer, getLineEndsSizeFnOfLineWidth, getLineEndStyle, getLineStartSize, getLineStartStyle, getLineStyle, getLineWidth, getLocallyRequestedEventTypes, getManipulator, getMargins, getMaximumHeight, getMaximumWidth, getMinimumHeight, getMinimumPickAreaSize, getMinimumSize, getMinimumWidth, getName, getNumberOfActionHandlers, getNumberOfAttachments, getNumberOfConnections, getNumberOfContainers, getNumberOfDeepConnections, getNumberOfEventHandlers, getNumberOfPoints, getNumberOfResources, getOutgoingInvalidLayoutNotificationsEnabled, getPoint, getPoint, getPointEntryAngle, getPointExitAngle, getPointX, getPointY, getPreferredSize, getPrototypeManipulator, getRelativeLocation, getResource, getResourceName, getRootWindow, getRotation, getSelectionGraphics, getShadowColor, getShadowDirection, getShadowLength, getShadowRenderer, getShadowStyle, getSize, getSnapPointManager, getSupportedExportFormats, getThisOrPartHasInvalidArea, getTotalNumberOfPartsCreated, getTransform, getTransparency, getValidatingLayout, getVisibilityAnimator, getWhiteColor, getWidth, getWriteMode, getXmax, getXmin, getXorColor, getYmax, getYmin, hasAttachment, hasAttribute, hasEnterKeyFocus, hasEventHandler, hasFixedAspectRatio, hasFixedHeight, hasFixedWidth, hasKeyboardFocus, hasMouseFocus, hasOverriddenMinimumSize, hasOverriddenPreferredSize, hasProperty, hasTotallyInvalidArea, hasValidLayout, insertActionHandler, insertActionHandler, insertActionHandler, insertConnection, insertContainer, insertEventHandler, insertItem, insertPoint, insertPoint, invalidateLayout, isAcceptingEnterKeyFocus, isAcceptingKeyboardFocus, isAcceptingMouseFocus, isAcceptingTabKeys, isActionDispatchingEnabled, isConnectable, isConnectedTo, isCopyable, isCopyableAsPartOfCopyable, isDeletable, isDoubleBuffered, isDragAndDropSource, isDragAndDropTarget, isFilled, isFontBold, isFontItalic, isFontUnderlined, isHidden, isMovable, isOpaqueRectangle, isPickable, isPickableWhenTransparent, isPrintable, isSavable, isSelectable, isSelected, isSensitive, isShowing, isSnappable, isUngroupable, isValidConnectionDestination, isValidConnectionSource, isVisible, makeImageFromArea, makeLayoutManipulator, makeManipulator, optimizedInvalidateArea, optimizedInvalidateDrawBoundsArea, overrideAttributes, overrideEventHandlingDisabledByContainer, packLayout, pickDeepList, preRenderToDoubleBuffer, refreshBounds, refreshLookAndFeel, removeActionHandler, removeActionHandler, removeActionHandlers, removeAllActionHandlers, removeAllAttachments, removeAllConnections, removeAllEventHandlers, removeAllManipulators, removeAttachment, removeAttachment, removeCommandHandler, removeCommandHandler, removeConnection, removeConnection, removeContainer, removeContainer, removeEventHandler, removeFromAllContainers, removeItem, removeItem, removePoint, removeResource, removeSelf, replaceDrawBounds, replaceSelf, requestEnterKeyFocus, requestKeyboardFocus, rotate, rotate, rotateTo, scale, scale, scale, set1DShapeStrokeBackgroundColor, set1DShapeStrokesFilled, setAcceptingEnterKeyFocus, setAcceptingKeyboardFocus, setAcceptingMouseFocus, setAcceptingTabKeys, setActionDispatchingEnabled, setAfterRenderer, setAlphaCompositeRenderMode, setAnnotationPointManager, setAttachmentDrawnAfter, setAttachmentMargins, setAttachmentsVisibility, setAttributeLockMask, setAttributePublicMask, setAttributeValue, setAttributeValue, setAttributeValue, setAttributeValue, setAttributeValue, setBackgroundColor, setBackgroundImage, setBackgroundRenderer, setBackgroundTile, setBalloonHelp, setBalloonHelpMessage, setBeforeRenderer, setBlackColor, setBorderHiliteColor, setBorderHiliteWidth, setBorderLook, setBorderRenderer, setBounds, setBounds, setCenter, setCenter, setCenterX, setCenterY, setColor, setColor, setConnectable, setConnectionPointManager, setContextCursor, setContextMenu, setControlPointManager, setCopyable, setCopyableAsPartOfCopyable, setCustomLookAndFeels, setCustomLookAndFeels, setDarkColor, setDeeplyInvalidateAreas, setDefaultAttributes, setDeletable, setDialogHelp, setDialogHelpMessage, setDoubleBuffer, setDoubleBuffered, setDragAndDropBehavior, setEventHandlingEnabled, setFilled, setFixedAspectRatio, setFixedHeight, setFixedWidth, setFont, setFontBold, setFontHorizontalJustification, setFontItalic, setFontPointSize, setFontUnderlined, setFontVerticalJustification, setHasBorderHilite, setHasShadow, setHeight, setHidden, setIncomingInvalidLayoutNotificationsEnabled, setInvalidAreaNotificationsEnabled, setInvalidLayoutNotificationsEnabled, setIsDragAndDropSource, setIsDragAndDropTarget, setIsOpaqueRectangle, setItem, setKeyFocusTraversalGroup, setLayout, setLightColor, setLineEndSize, setLineEndSizeFnOfLineWidth, setLineEndsRenderer, setLineEndStyle, setLineStartSize, setLineStartStyle, setLineStyle, setLineWidth, setMaximumHeight, setMaximumWidth, setMinimumHeight, setMinimumPickAreaSize, setMinimumSize, setMinimumWidth, setMovable,