com.swfm.mica.widgets
Class MiList

java.lang.Object
  com.swfm.mica.core.MiPart
      com.swfm.mica.core.MiContainer
          com.swfm.mica.layouts.MiLayout
              com.swfm.mica.core.MiVisibleContainer
                  com.swfm.mica.widgets.MiWidget
                      com.swfm.mica.widgets.MiTable
                          com.swfm.mica.widgets.MiList

All Implemented Interfaces:

MiiActionTypes, MiiAdjustableGrid, MiiAttributeTypes, MiiBackgroundableGrid, MiiCopyable, MiiDragAndDropParticipant, MiiEventTypes, MiiLayout, MiiNames, MiiPropertyTypes, MiiScrollableData, MiiSelectableTableContentSupplier, MiiTypes

public class MiList

extends MiTable

Version:

%I% %G%

Author:

Michael L. Davis

Field Summary

Constructor Summary

MiList()

MiList(boolean multipleSelectionsAllowed)

MiList(int numVisibleCharactersWide, boolean multipleSelectionsAllowed)

MiList(int numVisibleCharactersWide, int numVisibleRows, boolean multipleSelectionsAllowed)

Method Summary

boolean	activateItem(int index)
void	appendItem(MiPart obj) Appends the given item to this container.
void	appendItem(java.lang.String text)
void	appendItems(Strings items)
void	deSelectAll()
void	deSelectItem(int index)
void	doImport(MiDataTransferOperation transfer) Import the data specified by the given data transfer operation.
int	getBrowsedItemIndex()
Strings	getContents() Gets the contents (list of values) this widget displays.
int	getIndexOfItem(MiPart obj) Gets the index of the given item in this container.
int	getIndexOfItem(java.lang.String text)
int	getIndexOfItem(java.lang.String text, boolean ignoreCase)
int	getIndexOfTag(java.lang.Object tag)
int	getNumberOfItems() Gets the number of items this container has.
int	getNumberOfSelectedItems()
int	getNumberOfVisibleCharactersWide()
MiPart	getPartItem(int index)
MiPart	getPartWithTag(java.lang.Object tag)
java.lang.String	getSelectedItem()
int	getSelectedItemIndex()
int[]	getSelectedItemIndices()
java.lang.String[]	getSelectedItems()
MiPart	getSelectedObjectItem()
int	getSortDirection()
java.lang.String	getStringItem(int index)
Strings	getStringItems()
java.lang.Object	getTag(int index)
java.lang.String	getValue() Gets the value this widget displays.
void	insertItem(MiPart obj, int index) Inserts the given item at the given index into this container.
void	insertItem(java.lang.String text, int index)
boolean	isSelectable(int index)
boolean	isSelectedItem(int index)
boolean	isTextItem(int index)
MiText	makeMiText(java.lang.String text) Makes a text shape with the same look as the text that is made natively for this list.
void	makeVisible(int rowNumber)
void	refreshLookAndFeel()
void	removeAllItems() Removes all items from this container.
void	removeItem(int index) Removes the item from this container at the given index.
void	removeItem(MiPart part) Removes the given item from this container.
void	removeItem(java.lang.Object tag)
void	removeItem(java.lang.String text)
boolean	selectItem(int index)
void	selectItem(java.lang.String item)
void	setBackgroundColor(java.awt.Color c) Sets the background color.
void	setContents(Strings contents) Sets the contents (list of values) this widget displays.
void	setItem(MiPart obj, int index) Replaces the item at the given index with the given item.
void	setItem(java.lang.String text, int index)
void	setNumberOfVisibleCharactersWide(int numVisibleCharacters)
void	setSortDirection(int direction)
void	setTag(int index, java.lang.Object tag)
void	setTag(java.lang.String text, java.lang.Object tag)
void	setValue(java.lang.String value) Sets the value this widget displays.
void	toggleSelectItem(int index)
java.lang.String	toString() Returns information about this MiPart.

Methods inherited from class com.swfm.mica.widgets.MiTable

addCell, addCell, addCell, appendColumn, 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, getItem, 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, renderOverlay, 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

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, 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, 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, setKeyFocusTraversalGroup, setLayout, setLightColor, setLineEndSize, setLineEndSizeFnOfLineWidth, setLineEndsRenderer, setLineEndStyle, setLineStartSize, setLineStartStyle, setLineStyle, setLineWidth, setMaximumHeight, setMaximumWidth, setMinimumHeight, setMinimumPickAreaSize, setMinimumSize, setMinimumWidth, setMovable, setName, setNumberOfPoints, setOutgoingInvalidLayoutNotificationsEnabled, setPickable, setPickableWhenTransparent, setPoint, setPoint, setPreferredSize, setPrintable, setPrototypeManipulator, setResource, setSavable, setSelectable, setSelectionGraphics, setShadowColor, setShadowDirection, setShadowLength, setShadowRenderer, setShadowStyle, setSize, setSize, setSnappable, setSnapPointManager, setStatusHelp, setStatusHelpMessage, setSupportedImportFormats, setToolHintHelp, setToolHintMessage, setTransparency, setTransparency, setUngroupable, setVisibilityAnimator, setVisible, setWhiteColor, setWidth, setWriteMode, setXmax, setXmin, setXorColor, setYmax, setYmin, supportsImportOfSpecificInstance, translate, translate, translatePoint, validateLayout, validatePropertyValue, waitUntilRedrawn

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.swfm.mica.layouts.MiiLayout

getMinimumSize, getPreferredSize, invalidateLayout

Constructor Detail

MiList

public MiList()

MiList

public MiList(boolean multipleSelectionsAllowed)

MiList

public MiList(int numVisibleCharactersWide,
              boolean multipleSelectionsAllowed)

MiList

public MiList(int numVisibleCharactersWide,
              int numVisibleRows,
              boolean multipleSelectionsAllowed)

Method Detail

refreshLookAndFeel

public void refreshLookAndFeel()

Overrides:

refreshLookAndFeel in class MiTable

setBackgroundColor

public void setBackgroundColor(java.awt.Color c)

Description copied from class: MiPart

Sets the background color.

Overrides:

setBackgroundColor in class MiPart

Parameters:

c - the color

setNumberOfVisibleCharactersWide

public void setNumberOfVisibleCharactersWide(int numVisibleCharacters)

getNumberOfVisibleCharactersWide

public int getNumberOfVisibleCharactersWide()

insertItem

public void insertItem(java.lang.String text,
                       int index)

insertItem

public void insertItem(MiPart obj,
                       int index)

Description copied from class: MiPart

Inserts the given item at the given index into this container.

Overrides:

insertItem in class MiPart

Parameters:

obj - the item to insert

index - where to insert the item

appendItem

public void appendItem(java.lang.String text)

Overrides:

appendItem in class MiTable

appendItem

public void appendItem(MiPart obj)

Description copied from class: MiPart

Appends the given item to this container.

Overrides:

appendItem in class MiTable

appendItems

public void appendItems(Strings items)

Overrides:

appendItems in class MiTable

setItem

public void setItem(java.lang.String text,
                    int index)

setItem

public void setItem(MiPart obj,
                    int index)

Description copied from class: MiPart

Replaces the item at the given index