com.swfm.mica.widgets
Class MiTabbedFolder

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.MiTabbedFolder
All Implemented Interfaces:
MiiActionTypes, MiiAttributeTypes, MiiCopyable, MiiDragAndDropParticipant, MiiEventTypes, MiiLayout, MiiNames, MiiPropertyTypes, MiiTypes

public class MiTabbedFolder
extends MiWidget

Note: Make sure that one does not externally set folder contents visible, causing 2 folders to be visible at one time, as this will cause one folder to be very short. Use instead #setOpenFolder

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

Field Summary
static java.lang.String Mi_SELECTED_TAB_ATTRIBUTES
           
static java.lang.String Mi_TAB_ATTRIBUTES
           
                   
Constructor Summary
MiTabbedFolder()
           
 
Method Summary
 MiPart appendFolder(MiPart label)
           
 void appendFolder(MiPart label, MiPart contents)
           
 MiPart appendFolder(java.lang.String label)
           
 void appendFolder(java.lang.String label, MiPart contents)
           
 void calcMinimumSize(MiSize size)
          Gets the minimum size of this MiPart.
 void calcPreferredSize(MiSize size)
          Gets the preferred size of this MiPart.
 MiPart getBorderGraphics()
           
 MiPart getFolderContents(int index)
           
 MiPart getFolderContents(java.lang.String name)
           
 int getFolderIndex(java.lang.String name)
           
 MiPart getFolderLabel(int index)
           
 MiPart getFolderLabel(java.lang.String name)
           
 java.lang.String getFolderLabelString(int index)
           
 MiPart getFolderTab(int index)
           
 MiPart getFolderTab(java.lang.String name)
           
 MiPart getFolderTabBorder(int index)
           
 MiMargins getInnerMargins()
           
 double getLeftSlantAngle()
           
 int getNumberOfFolders()
           
 MiPart getOpenFolder()
           
 int getOpenFolderIndex()
           
 java.lang.String getOpenFolderName()
           
 java.lang.String getPropertyValue(java.lang.String name)
          Gets the textual value of the property with the given name.
 double getRightSlantAngle()
           
 boolean getSameWidthForAllTabs()
           
 MiMargins getTabMargins()
           
 java.lang.String getValue()
          Gets the value this widget displays.
 boolean hasFolder(java.lang.String name)
           
 MiPart insertFolder(MiPart label, int index)
           
 void insertFolder(MiPart label, MiPart contents, int index)
           
 MiPart insertFolder(java.lang.String label, int index)
           
 void insertFolder(java.lang.String label, MiPart contents, int index)
           
 void refreshLookAndFeel()
           
 void removeFolder(int index)
           
 void removeFolder(java.lang.String name)
           
 void setFolderContents(MiPart contents, int index)
           
 void setFolderLabel(int index, MiPart newLabel)
           
 void setFolderLabel(int index, java.lang.String name)
           
 void setInnerMargins(MiMargins m)
           
 void setLeftSlantAngle(double d)
           
 void setOpenFolder(int index)
           
 void setOpenFolder(java.lang.String name)
           
 void setPropertyValue(java.lang.String name, java.lang.String value)
          Sets the property with the given name to the given value.
 void setRightSlantAngle(double d)
           
 void setSameWidthForAllTabs(boolean f)
           
 void setTabMargins(MiMargins d)
           
 void setValue(java.lang.String value)
          Sets the value this widget displays.
 
Methods inherited from class com.swfm.mica.widgets.MiWidget
copy, doExport, getContents, 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, setContents, 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
getContainerLayoutSpec, getDisplaysFocusBorder, getInnerBounds, getIntersectionWithLine, getOKToDrawOutsideInnerBounds, getShadowShape, getShape, getTotalMargins, getVisibleContainerAutomaticLayoutEnabled, invalidateArea, 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, doImport, 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, appendItem, 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, getContextCursor, getContextMenu, 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, getIndexOfItem, getInnerBounds, getInvalidAreaNotificationsEnabled, getInvalidLayoutNotificationsEnabled, getItem, 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, getNumberOfItems, getNumberOfPoints, getNumberOfResources, getOutgoingInvalidLayoutNotificationsEnabled, getPoint, getPoint, getPointEntryAngle, getPointExitAngle, getPointX, getPointY, getPreferredSize, getPrototypeManipulator, getRelativeLocation, getResource, getResourceName, getRootWindow, getRotation, getSelectionGraphics, getShadowColor, getShadowDirection, getShadowLength, getShadowRenderer, getShadowStyle, getSize, getSnapPointManager, getStatusHelp, getSupportedExportFormats, getThisOrPartHasInvalidArea, getToolHintHelp, 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, invalidateArea, 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, removeAllItems, 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, 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, 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
 

Field Detail

Mi_SELECTED_TAB_ATTRIBUTES

public static final java.lang.String Mi_SELECTED_TAB_ATTRIBUTES
See Also:
Constant Field Values

Mi_TAB_ATTRIBUTES

public static final java.lang.String Mi_TAB_ATTRIBUTES
See Also:
Constant Field Values
Constructor Detail

MiTabbedFolder

public MiTabbedFolder()
Method Detail

setTabMargins

public void setTabMargins(MiMargins d)

getTabMargins

public MiMargins getTabMargins()

getBorderGraphics

public MiPart getBorderGraphics()

setInnerMargins

public void setInnerMargins(MiMargins m)

getInnerMargins

public MiMargins getInnerMargins()

appendFolder

public MiPart appendFolder(java.lang.String label)

appendFolder

public MiPart appendFolder(MiPart label)

appendFolder

public void appendFolder(java.lang.String label,
                         MiPart contents)

appendFolder

public void appendFolder(MiPart label,
                         MiPart contents)

insertFolder

public MiPart insertFolder(java.lang.String label,
                           int index)

insertFolder

public MiPart insertFolder(MiPart label,
                           int index)

insertFolder

public void insertFolder(java.lang.String label,
                         MiPart contents,
                         int index)

insertFolder

public void insertFolder(MiPart label,
                         MiPart contents,
                         int index)

getNumberOfFolders

public int getNumberOfFolders()

getFolderContents

public MiPart getFolderContents(java.lang.String name)

getFolderLabel

public MiPart getFolderLabel(java.lang.String name)

getFolderTab

public MiPart getFolderTab(java.lang.String name)

getFolderTab

public MiPart getFolderTab(int index)

getFolderTabBorder

public MiPart getFolderTabBorder(int index)

setFolderLabel

public void setFolderLabel(int index,
                           MiPart newLabel)

setFolderLabel

public void setFolderLabel(int index,
                           java.lang.String name)

removeFolder

public void removeFolder(java.lang.String name)

removeFolder

public void removeFolder(int index)

getFolderContents

public MiPart getFolderContents(int index)

setFolderContents

public void setFolderContents(MiPart contents,
                              int index)

getFolderLabel

public MiPart getFolderLabel(int index)

getFolderLabelString

public java.lang.String getFolderLabelString(int index)

hasFolder

public boolean hasFolder(java.lang.String name)

getFolderIndex

public int getFolderIndex(java.lang.String name)

getOpenFolderName

public java.lang.String getOpenFolderName()

getOpenFolderIndex

public int getOpenFolderIndex()

getOpenFolder

public MiPart getOpenFolder()

setValue

public void setValue(java.lang.String value)
Description copied from class: MiWidget
Sets the value this widget displays. Override this, if desired, as it implements the core functionality. Most widgets do.

Overrides:
setValue in class MiWidget
Parameters:
value - the value in the form of a text string

getValue

public java.lang.String getValue()
Description copied from class: MiWidget
Gets the value this widget displays. Override this, if desired, as it implements the core functionality. Most widgets do.

Overrides:
getValue in class MiWidget
Returns:
the value in the form of a text string

setOpenFolder

public void setOpenFolder(java.lang.String name)

setOpenFolder

public void setOpenFolder(int index)

getLeftSlantAngle

public double getLeftSlantAngle()

setLeftSlantAngle

public void setLeftSlantAngle(double d)

getRightSlantAngle

public double getRightSlantAngle()

setRightSlantAngle

public void setRightSlantAngle(double d)

getSameWidthForAllTabs

public boolean getSameWidthForAllTabs()

setSameWidthForAllTabs

public void setSameWidthForAllTabs(boolean f)

setPropertyValue

public void setPropertyValue(java.lang.String name,
                             java.lang.String value)
Sets the property with the given name to the given value. This method supports the use of property names of form: selected.backgroundColor in order to specify the values of attributes for this widget on a state by state basis.

Overrides:
setPropertyValue in class MiWidget
Parameters:
name - the name of an property
value - the value of the property

getPropertyValue

public java.lang.String getPropertyValue(java.lang.String name)
Gets the textual value of the property with the given name. If the value is null then MiiTypes.Mi_NULL_VALUE_NAME is returned.

Overrides:
getPropertyValue in class MiWidget
Parameters:
name - the name of a property
Returns:
the string value of the property

refreshLookAndFeel

public void refreshLookAndFeel()
Overrides:
refreshLookAndFeel in class MiPart

calcMinimumSize

public void calcMinimumSize(MiSize size)
Description copied from class: MiVisibleContainer
Gets the minimum size of this MiPart. Override this, if desired, as it implements the core functionality.

Overrides:
calcMinimumSize in class MiVisibleContainer
Parameters:
size - the (returned) minimum size
See Also:
MiPart.getMinimumSize(com.swfm.mica.core.MiSize)

calcPreferredSize

public void calcPreferredSize(MiSize size)
Description copied from class: MiVisibleContainer
Gets the preferred size of this MiPart. Override this, if desired, as it implements the core functionality.

Overrides:
calcPreferredSize in class MiVisibleContainer
Parameters:
size - the (returned) preferred size
See Also:
MiPart.getPreferredSize(com.swfm.mica.core.MiSize)