com.swfm.mica.widgets
Class MiLabeledWidget

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.MiLabeledWidget

All Implemented Interfaces:

MiiActionHandler, MiiActionTypes, MiiAttributeTypes, MiiCopyable, MiiDragAndDropParticipant, MiiEventTypes, MiiLayout, MiiNames, MiiPropertyTypes, MiiTypes

public class MiLabeledWidget

extends MiWidget

implements MiiActionHandler

Version:

%I% %G%

Author:

Michael L. Davis

Field Summary

Constructor Summary

MiLabeledWidget(MiWidget widget, java.lang.String label)

MiLabeledWidget(java.lang.String label, MiWidget widget)

Method Summary

void	copy(MiPart source) Copies the given MiPart.
MiPart	deepCopy() Makes and returns a copy of this container and all of it's parts.
MiText	getLabel()
java.lang.String	getValue() Gets the value this widget displays.
MiWidget	getWidget()
void	insertActionHandler(MiiAction action, int index) Inserts the given action, which will be sent to it's action handler when any of it's valid actions occur, at the given index.
boolean	isSelected() Gets whether this MiPart is selected.
boolean	isSensitive() Gets whether this MiPart is sensitive.
boolean	processAction(MiiAction action) Processes the given action.
void	refreshLookAndFeel()
void	removeActionHandler(int index) Removes the action handler at the given index.
void	removeActionHandler(MiiAction action) Removes the given action from the list of actions that this MiPart calls.
void	removeActionHandlers(MiiActionHandler handler) Removes every instance of the given action handler from the list of action handlers this MiPart calls.
void	removeAllActionHandlers() Removes all action handlers.
void	select(boolean flag) Update the attributes of this widget while setting it's selected state.
void	setAttributes(MiAttributes atts) Sets the attributes the widget is to have in the normal state.
void	setLabelLocation(int location) Mi_LEFT_LOCATION Mi_RIGHT_LOCATION Mi_BOTTOM_LOCATION Mi_TOP_LOCATION
void	setSensitive(boolean flag) Update the attributes of this widget while setting it's sensitivity.
void	setValue(java.lang.String value) Sets the value this widget displays.

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

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, getPropertyValue, getRadioStateEnforcer, getSelectedAttributes, getSelectedBackgroundColor, getSelectedBorderLook, getSelectedColor, getSelectedStatusHelp, getToolkit, getWidgetAttributes, isAutoAttributesEnabled, isDesignTime, 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, setPropertyValue, setPropertyValues, setRadioStateEnforcer, setSelectedAttributes, setSelectedBackgroundColor, setSelectedBorderLook, setSelectedColor, setSelectedStatusHelpMessage, setWidgetAttributes, setWidgetAttributes

Methods inherited from class com.swfm.mica.core.MiVisibleContainer

calcMinimumSize, calcPreferredSize, 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, 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, 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, isShowing, isSnappable, isUngroupable, isValidConnectionDestination, isValidConnectionSource, isVisible, makeImageFromArea, makeLayoutManipulator, makeManipulator, optimizedInvalidateArea, optimizedInvalidateDrawBoundsArea, overrideAttributes, overrideEventHandlingDisabledByContainer, packLayout, pickDeepList, preRenderToDoubleBuffer, refreshBounds, refreshLookAndFeel, 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

Constructor Detail

MiLabeledWidget

public MiLabeledWidget(java.lang.String label,
                       MiWidget widget)

MiLabeledWidget

public MiLabeledWidget(MiWidget widget,
                       java.lang.String label)

Method Detail

select

public void select(boolean flag)

Description copied from class: MiWidget

Update the attributes of this widget while setting it's selected state. Before the selection state is changed the radioStateEnforcer, if any, is checked to verify the change.

Overrides:

select in class MiWidget

Parameters:

flag - true if selected

See Also:

MiWidget.setRadioStateEnforcer(com.swfm.mica.widgets.MiRadioStateEnforcer)

isSelected

public boolean isSelected()

Description copied from class: MiPart

Gets whether this MiPart is selected.

Overrides:

isSelected in class MiPart

Returns:

true if this is selected

setSensitive

public void setSensitive(boolean flag)

Description copied from class: MiWidget

Update the attributes of this widget while setting it's sensitivity.

Overrides:

setSensitive in class MiWidget

Parameters:

flag - true if sensitive

isSensitive

public boolean isSensitive()

Description copied from class: MiPart

Gets whether this MiPart is sensitive.

Overrides:

isSensitive in class MiPart

Returns:

true if this is sensitive

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

getLabel

public MiText getLabel()

setLabelLocation

public void setLabelLocation(int location)

Mi_LEFT_LOCATION Mi_RIGHT_LOCATION Mi_BOTTOM_LOCATION Mi_TOP_LOCATION

getWidget

public MiWidget getWidget()

insertActionHandler

public void insertActionHandler(MiiAction action,
                                int index)

Description copied from class: MiPart

Inserts the given action, which will be sent to it's action handler when any of it's valid actions occur, at the given index.

Overrides:

insertActionHandler in class MiPart

Parameters:

action - the action to insert

index - the index of the insertion point

removeActionHandler

public void removeActionHandler(MiiAction action)

Description copied from class: MiPart

Removes the given action from the list of actions that this MiPart calls.

Overrides:

removeActionHandler in class MiPart

Parameters:

action - the action to remove

removeActionHandlers

public void removeActionHandlers(MiiActionHandler handler)

Description copied from class: MiPart

Removes every instance of the given action handler from the list of action handlers this MiPart calls.

Overrides:

removeActionHandlers in class MiPart

Parameters:

handler - the action handler to remove

removeActionHandler

public void removeActionHandler(int index)

Description copied from class: MiPart

Removes the action handler at the given index.

Overrides:

removeActionHandler in class MiPart

Parameters:

index - the position of the action handler to remove

removeAllActionHandlers

public void removeAllActionHandlers()

Description copied from class: MiPart

Removes all action handlers.

Overrides:

removeAllActionHandlers in class MiPart

setAttributes

public void setAttributes(MiAttributes atts)

Description copied from class: MiWidget

Sets the attributes the widget is to have in the normal state. So that when, say, setColor is called on a widget, this color will be used when the widget is in the 'normal' state.

Overrides:

setAttributes in class MiWidget

Parameters:

atts - the attributes

See Also:

MiPart.setAttributes(com.swfm.mica.core.MiAttributes)

processAction

public boolean processAction(MiiAction action)

Description copied from interface: MiiActionHandler

Processes the given action.

Specified by:

processAction in interface MiiActionHandler

Parameters:

action - the action to process

Returns:

true if it is OK to send action to the next action handler false if it is NOT OK to send action to the next action handler

refreshLookAndFeel

public void refreshLookAndFeel()

Overrides:

refreshLookAndFeel in class MiPart

copy

public void copy(MiPart source)

Copies the given MiPart. This MiPart will have the same attributes, bounds, resources, attachments, layouts, action handlers, and event handlers as the given MiPart.

Overrides:

copy in class MiWidget

Parameters:

source - the part to copy

See Also:

MiPart.copy()

deepCopy

public MiPart deepCopy()

Description copied from class: MiContainer

Makes and returns a copy of this container and all of it's parts.

Overrides:

deepCopy in class MiContainer

Returns:

the copy

See Also:

MiPart.copy()