com.swfm.mica.widgets
Class MiButton

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.MiLabel
                          com.swfm.mica.widgets.MiButton

All Implemented Interfaces:

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

Direct Known Subclasses:

MiCheckBox, MiMenuLauncherButton, MiPushButton, MiToggleButton

public abstract class MiButton

extends MiLabel

implements MiiCommandHandler

This abstract class is the base class for all sorts of button widgets.

Version:

%I% %G%

Author:

Michael L. Davis

Field Summary

static java.lang.String	Mi_FOCUS_LABEL_PROPERTY_NAME
static java.lang.String	Mi_INSENSITIVE_LABEL_PROPERTY_NAME
static java.lang.String	Mi_LABEL_PROPERTY_NAME
static java.lang.String	Mi_SELECTED_LABEL_PROPERTY_NAME

Constructor Summary

MiButton()
Constructs a new MiButton.

MiButton(MiPart obj)
Constructs a new MiButton with the given graphics label.

MiButton(java.lang.String text)
Constructs a new MiButton with the given text label.

Method Summary

void	appendShortCut(MiEvent event) Add a short cut to this button.
void	copy(MiPart source) Copy the state of this MiPart into the target MiPart.
MiPart	getFocusLabel() Gets the label to be displayed when this button has keyboard and or mouse focus.
MiPart	getInsensitiveLabel() Gets the label to be displayed when this button is not sensitive.
MiPart	getNormalLabel() Gets the label to be displayed when this button is sensitive, not selected and with neither mouse or keyboard focus.
MiPropertyDescriptions	getPropertyDescriptions() Gets the descriptions of all of the properties.
java.lang.String	getPropertyValue(java.lang.String name) Gets the textual value of the property with the given name.
MiPart	getSelectedLabel() Gets the label to be displayed when this button is selected.
boolean	hasProperty(java.lang.String name) Returns whether the property with the given name is valid.
void	processCommand(java.lang.String arg) Executes/selects this button.
void	select(boolean flag) Sets the button's selected state.
void	select(boolean flag, boolean dispatchValueChangedActionUponSelect) Sets the button's selected state.
void	setFocusLabel(MiPart label) Sets the label to be displayed when this button has keyboard and or mouse focus.
void	setFocusLabel(java.lang.String label) Sets the label to be displayed when this button has keyboard and or mouse focus.
void	setInsensitiveLabel(MiPart label) Sets the label to be displayed when this button is not sensitive.
void	setInsensitiveLabel(java.lang.String label) Sets the label to be displayed when this button is not sensitive.
void	setKeyboardFocus(boolean flag) Sets the buttons keyboard focus state.
void	setLabel(MiPart obj) Sets the label of this widget.
void	setMouseFocus(boolean flag) Sets the buttons mouse focus state.
void	setNormalLabel(MiPart label) Sets the label to be displayed when this button is sensitive, not selected and with neither mouse or keyboard focus.
void	setNormalLabel(java.lang.String label) Sets the label to be displayed when this button is sensitive, not selected and with neither mouse or keyboard focus.
void	setPropertyValue(java.lang.String name, java.lang.String value) Sets the property with the given name to the given value.
void	setSelectedLabel(MiPart label) Sets the label to be displayed when this button is selected.
void	setSelectedLabel(java.lang.String label) Sets the label to be displayed when this button is selected.
void	setValue(java.lang.String text) Set the value of this widget, which is the label, to the given text.

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

create, getLabel, getPrototype, getValue, setLabel, setPrototype, setSensitive, toString

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, getRadioStateEnforcer, getSelectedAttributes, getSelectedBackgroundColor, getSelectedBorderLook, getSelectedColor, getSelectedStatusHelp, getToolkit, getWidgetAttributes, isAutoAttributesEnabled, isDesignTime, setAttributes, setAutoAttributesEnabled, setContents, setCurrentBackgroundColor, setCurrentColor, setEnterKeyFocus, setEnterKeyFocusAttributes, setEnterKeyFocusBackgroundColor, setEnterKeyFocusBorderLook, setEnterKeyFocusColor, setEnterKeyFocusStatusHelpMessage, setInSensitiveAttributes, setInSensitiveBackgroundColor, setInSensitiveBorderLook, setInSensitiveColor, setInSensitiveStatusHelpMessage, setKeyboardFocusAttributes, setKeyboardFocusBackgroundColor, setKeyboardFocusBorderLook, setKeyboardFocusColor, setKeyboardFocusStatusHelpMessage, setMouseFocusAttributes, setMouseFocusBackgroundColor, setMouseFocusBorderLook, setMouseFocusColor, setMouseFocusStatusHelpMessage, setNormalAttributes, setNormalBackgroundColor, setNormalBorderLook, setNormalColor, setNormalStatusHelpMessage, 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

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, 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, 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_FOCUS_LABEL_PROPERTY_NAME

public static final java.lang.String Mi_FOCUS_LABEL_PROPERTY_NAME

See Also:

Constant Field Values

Mi_SELECTED_LABEL_PROPERTY_NAME

public static final java.lang.String Mi_SELECTED_LABEL_PROPERTY_NAME

See Also:

Constant Field Values

Mi_INSENSITIVE_LABEL_PROPERTY_NAME

public static final java.lang.String Mi_INSENSITIVE_LABEL_PROPERTY_NAME

See Also:

Constant Field Values

Mi_LABEL_PROPERTY_NAME

public static final java.lang.String Mi_LABEL_PROPERTY_NAME

See Also:

Constant Field Values

Constructor Detail

MiButton

public MiButton()

Constructs a new MiButton.

MiButton

public MiButton(java.lang.String text)

Constructs a new MiButton with the given text label.

MiButton

public MiButton(MiPart obj)

Constructs a new MiButton with the given graphics label.

Method Detail

setValue

public void setValue(java.lang.String text)

Set the value of this widget, which is the label, to the given text. The text is parsed in order to assign any short cuts specified in the label. The given text is of form: labe&l\tCtrl+C where the optional '&' indicates that the character following is to be a short cut (when widget is visible) and the '\t' indicates the following event is to be a short cut.

Overrides:

setValue in class MiLabel

Parameters:

text - the new label

appendShortCut

public void appendShortCut(MiEvent event)

Add a short cut to this button. The end-user can use this short cut to select this button and thereby invoke any this button's action handlers.

Parameters:

event - the short cut

setLabel

public void setLabel(MiPart obj)

Sets the label of this widget.

Overrides:

setLabel in class MiLabel

Parameters:

obj - the new label

setNormalLabel

public void setNormalLabel(java.lang.String label)

Sets the label to be displayed when this button is sensitive, not selected and with neither mouse or keyboard focus.

Parameters:

label - the normal-state label

setNormalLabel

public void setNormalLabel(MiPart label)

Sets the label to be displayed when this button is sensitive, not selected and with neither mouse or keyboard focus.

Parameters:

label - the normal-state label

getNormalLabel

public MiPart getNormalLabel()

Gets the label to be displayed when this button is sensitive, not selected and with neither mouse or keyboard focus.

Returns:

the normal-state label

setSelectedLabel

public void setSelectedLabel(java.lang.String label)

Sets the label to be displayed when this button is selected.

Parameters:

label - the selected-state label

setSelectedLabel

public void setSelectedLabel(MiPart label)

Sets the label to be displayed when this button is selected.

Parameters:

label - the selected-state label

getSelectedLabel

public MiPart getSelectedLabel()

Gets the label to be displayed when this button is selected.

Returns:

the selected-state label

setInsensitiveLabel

public void setInsensitiveLabel(java.lang.String label)

Sets the label to be displayed when this button is not sensitive.

Parameters:

label - the insensitive-state label

setInsensitiveLabel

public void setInsensitiveLabel(MiPart label)

Sets the label to be displayed when this button is not sensitive.

Parameters:

label - the insensitive-state label

getInsensitiveLabel

public MiPart getInsensitiveLabel()

Gets the label to be displayed when this button is not sensitive.

Returns:

the insensitive-state label

setFocusLabel

public void setFocusLabel(java.lang.String label)

Sets the label to be displayed when this button has keyboard and or mouse focus.

Parameters:

label - the focus-state label

setFocusLabel

public void setFocusLabel(MiPart label)

Sets the label to be displayed when this button has keyboard and or mouse focus.

Parameters:

label - the focus-state label

getFocusLabel

public MiPart getFocusLabel()

Gets the label to be displayed when this button has keyboard and or mouse focus.

Returns:

the focus-state label

select

public void select(boolean flag)

Sets the button's selected state. Updates the label to the corresponding special appearance, if any.

Overrides:

select in class MiWidget

Parameters:

flag - true if this is selected

See Also:

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

select

public void select(boolean flag,
                   boolean dispatchValueChangedActionUponSelect)

Sets the button's selected state. Updates the label to the corresponding special appearance, if any.

Parameters:

flag - true if this is selected

dispatchValueChangedActionUponSelect - this is false only for MiMenuLauncherButton and the like whose value does not change, they just popup a menu

setMouseFocus

public void setMouseFocus(boolean flag)

Sets the buttons mouse focus state. Updates the label to the corresponding special appearance, if any.

Overrides:

setMouseFocus in class MiWidget

Parameters:

flag - true if this is selected

setKeyboardFocus

public void setKeyboardFocus(boolean flag)

Sets the buttons keyboard focus state. Updates the label to the corresponding special appearance, if any.

Overrides:

setKeyboardFocus in class MiWidget

Parameters:

flag - true if this is selected

processCommand

public void processCommand(java.lang.String arg)

Executes/selects this button. This is called when the end-user uses the keybaord or mouse to processCommand a short cut.

Specified by:

processCommand in interface MiiCommandHandler

Parameters:

arg - the command argument

setPropertyValue

public void setPropertyValue(java.lang.String name,
                             java.lang.String value)

Sets the property with the given name to the given value. If no such property is found then sets the attribute with the given name to the given value. Valid attribute names are found in the MiiNames.attributeNames array.

Overrides:

setPropertyValue in class MiWidget

Parameters:

name - the name of an attribute

value - the value of the attribute

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

getPropertyDescriptions

public MiPropertyDescriptions getPropertyDescriptions()

Gets the descriptions of all of the properties. These can be used to see if an property is different from the default value or if a proposed value is valid or to get a list of all of the valid values of a property. THIS DOESN'T WORK BECAUSE THE PROPERTIES startWith THESE PROPERTY NAMES...

Overrides:

getPropertyDescriptions in class MiWidget

Returns:

the list of property descriptions

hasProperty

public boolean hasProperty(java.lang.String name)

Description copied from class: MiPart

Returns whether the property with the given name is valid. If not, this then checks to see whether an attribute exsits with the given name.

Overrides:

hasProperty in class MiPart

Parameters:

name - the name of an property or attribute

Returns:

true if the name is valid.

copy

public void copy(MiPart source)

Copy the state of this MiPart into the target MiPart.

Overrides:

copy in class MiLabel

See Also:

MiPart.copy()