jfxtras.labs.scene.control

Class MiniIconButton

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

javafx.scene.control.Labeled

javafx.scene.control.ButtonBase

javafx.scene.control.Button

jfxtras.labs.scene.control.MiniIconButton

All Implemented Interfaces:

javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable

public class MiniIconButton
extends javafx.scene.control.Button

The MiniIconButton is an extension of the standard button. It gets a second icon, which can be placed above the normal button. The icon is minified and shown

Property Summary

Type	Property and Description
javafx.beans.property.DoubleProperty	animationDuration This is the duration in milliseconds for the two animation types AnimationType.BLINK and AnimationType.JUMP the default is 500
javafx.beans.property.ObjectProperty<MiniIconButton.AnimationType>	animationType The property for the animation type.
javafx.beans.property.ObjectProperty<javafx.geometry.Pos>	miniIconPosition The mini-icon can be positioned with <code>Pos</code>
javafx.beans.property.ObjectProperty<javafx.scene.image.ImageView>	miniIcon The property of the mini icon
javafx.beans.property.DoubleProperty	miniIconRatio This is the ratio of the mini-icon corresponding to the button.

Properties inherited from class javafx.scene.control.Button

cancelButtonProperty, defaultButtonProperty

Properties inherited from class javafx.scene.control.ButtonBase

armedProperty, onActionProperty

Properties inherited from class javafx.scene.control.Labeled

alignmentProperty, contentDisplayProperty, ellipsisStringProperty, fontProperty, graphicProperty, graphicTextGapProperty, labelPaddingProperty, lineSpacingProperty, mnemonicParsingProperty, textAlignmentProperty, textFillProperty, textOverrunProperty, textProperty, underlineProperty, wrapTextProperty

Properties inherited from class javafx.scene.control.Control

contextMenuProperty, skinClassNameProperty, skinProperty, tooltipProperty

Properties inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, heightProperty, insetsProperty, maxHeightProperty, maxWidthProperty, minHeightProperty, minWidthProperty, opaqueInsetsProperty, paddingProperty, prefHeightProperty, prefWidthProperty, scaleShapeProperty, shapeProperty, snapToPixelProperty, widthProperty

Properties inherited from class javafx.scene.Parent

impl_traversalEngineProperty, needsLayoutProperty

Properties inherited from class javafx.scene.Node

blendModeProperty, boundsInLocalProperty, boundsInParentProperty, cacheHintProperty, cacheProperty, clipProperty, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, focusedProperty, focusTraversableProperty, hoverProperty, idProperty, impl_showMnemonicsProperty, impl_treeVisibleProperty, inputMethodRequestsProperty, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParentTransformProperty, localToSceneTransformProperty, managedProperty, mouseTransparentProperty, nodeOrientationProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, pickOnBoundsProperty, pressedProperty, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, styleProperty, translateXProperty, translateYProperty, translateZProperty, visibleProperty

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MiniIconButton.AnimationType Type of animation

Field Summary

Fields inherited from class javafx.scene.layout.Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Constructor Summary

Constructors

Constructor and Description
MiniIconButton() creates an empty mini icon button
MiniIconButton(javafx.scene.image.ImageView miniIcon) creates an empty button with a mini icon set
MiniIconButton(javafx.scene.Node graphic, javafx.scene.image.ImageView miniIcon) creates a button with icon and a mini icon set
MiniIconButton(java.lang.String text, javafx.scene.image.ImageView miniIcon) creates a text button with a mini icon set
MiniIconButton(java.lang.String text, javafx.scene.Node graphic, javafx.scene.image.ImageView miniIcon) creates a button with text and icon and a mini icon set

Method Summary

Modifier and Type	Method and Description
javafx.beans.property.DoubleProperty	animationDurationProperty() This is the duration in milliseconds for the two animation types AnimationType.BLINK and AnimationType.JUMP the default is 500
javafx.beans.property.ObjectProperty<MiniIconButton.AnimationType>	animationTypeProperty() The property for the animation type.
double	getAnimationDuration() Returns the duration in milliseconds for the two animation types AnimationType.BLINK and AnimationType.JUMP the default is 500
MiniIconButton.AnimationType	getAnimationType() Returns the animation type.
javafx.scene.image.ImageView	getMiniIcon() Returns the mini icon
javafx.geometry.Pos	getMiniIconPosition() Returns the position of the mini-icon based on <code>Pos</code>
double	getMiniIconRatio() Returns the value of the mini-icon ratio.
protected java.lang.String	getUserAgentStylesheet()
javafx.beans.property.ObjectProperty<javafx.geometry.Pos>	miniIconPositionProperty() The mini-icon can be positioned with <code>Pos</code>
javafx.beans.property.ObjectProperty<javafx.scene.image.ImageView>	miniIconProperty() The property of the mini icon
javafx.beans.property.DoubleProperty	miniIconRatioProperty() This is the ratio of the mini-icon corresponding to the button.
void	setAnimationDuration(double value) Sets the animation duration in milli seconds
void	setAnimationType(MiniIconButton.AnimationType value) Sets the animation type.
void	setMiniIcon(javafx.scene.image.ImageView value) Sets the mini icon
void	setMiniIconPosition(javafx.geometry.Pos value) Sets the position of the mini icon with <code>Pos</code>
void	setMiniIconRatio(double value) Sets the ratio of the mini-icon corresponding to the buttons size

Methods inherited from class javafx.scene.control.Button

cancelButtonProperty, createDefaultSkin, defaultButtonProperty, fire, impl_getAccessible, isCancelButton, isDefaultButton, setCancelButton, setDefaultButton

Methods inherited from class javafx.scene.control.ButtonBase

arm, armedProperty, disarm, getOnAction, isArmed, onActionProperty, setOnAction

Methods inherited from class javafx.scene.control.Labeled

alignmentProperty, contentDisplayProperty, ellipsisStringProperty, fontProperty, getAlignment, getClassCssMetaData, getContentBias, getContentDisplay, getControlCssMetaData, getEllipsisString, getFont, getGraphic, getGraphicTextGap, getLabelPadding, getLineSpacing, getText, getTextAlignment, getTextFill, getTextOverrun, graphicProperty, graphicTextGapProperty, impl_cssGetAlignmentInitialValue, isMnemonicParsing, isUnderline, isWrapText, labelPaddingProperty, lineSpacingProperty, mnemonicParsingProperty, setAlignment, setContentDisplay, setEllipsisString, setFont, setGraphic, setGraphicTextGap, setLineSpacing, setMnemonicParsing, setText, setTextAlignment, setTextFill, setTextOverrun, setUnderline, setWrapText, textAlignmentProperty, textFillProperty, textOverrunProperty, textProperty, toString, underlineProperty, wrapTextProperty

Methods inherited from class javafx.scene.control.Control

computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, getBaselineOffset, getContextMenu, getCssMetaData, getSkin, getTooltip, impl_cssGetFocusTraversableInitialValue, impl_processCSS, isResizable, layoutChildren, setContextMenu, setSkin, setTooltip, skinClassNameProperty, skinProperty, tooltipProperty

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getWidth, heightProperty, impl_computeContains, impl_computeGeomBounds, impl_computeLayoutBounds, impl_createPeer, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePeer, insetsProperty, isCacheShape, isCenterShape, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getChildren, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, setImpl_traversalEngine, setNeedsLayout

Methods inherited from class javafx.scene.Node

addEventFilter, addEventHandler, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_geomChanged, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Property Detail

miniIcon

public final javafx.beans.property.ObjectProperty<javafx.scene.image.ImageView> miniIconProperty

The property of the mini icon

See Also:

getMiniIcon(), setMiniIcon(ImageView)

animationType

public final javafx.beans.property.ObjectProperty<MiniIconButton.AnimationType> animationTypeProperty

The property for the animation type.

See Also:

getAnimationType(), setAnimationType(AnimationType)

miniIconPosition

public final javafx.beans.property.ObjectProperty<javafx.geometry.Pos> miniIconPositionProperty

The mini-icon can be positioned with <code>Pos</code>

See Also:

getMiniIconPosition(), setMiniIconPosition(Pos)

miniIconRatio

public final javafx.beans.property.DoubleProperty miniIconRatioProperty

This is the ratio of the mini-icon corresponding to the button. It could be a double number between 0.01 and 1.0.

See Also:

getMiniIconRatio(), setMiniIconRatio(double)

animationDuration

public final javafx.beans.property.DoubleProperty animationDurationProperty

This is the duration in milliseconds for the two animation types AnimationType.BLINK and AnimationType.JUMP the default is 500

See Also:

getAnimationDuration(), setAnimationDuration(double)

Constructor Detail

MiniIconButton

public MiniIconButton()

creates an empty mini icon button

MiniIconButton

public MiniIconButton(javafx.scene.image.ImageView miniIcon)

creates an empty button with a mini icon set

Parameters:

miniIcon - the mini icon shown in front of the button

MiniIconButton

public MiniIconButton(java.lang.String text,
                      javafx.scene.image.ImageView miniIcon)

creates a text button with a mini icon set

Parameters:

text - A text string for its label.

miniIcon - the mini icon shown in front of the button

MiniIconButton

public MiniIconButton(javafx.scene.Node graphic,
                      javafx.scene.image.ImageView miniIcon)

creates a button with icon and a mini icon set

Parameters:

graphic - the icon for its label.

miniIcon - the mini icon shown in front of the button

MiniIconButton

public MiniIconButton(java.lang.String text,
                      javafx.scene.Node graphic,
                      javafx.scene.image.ImageView miniIcon)

creates a button with text and icon and a mini icon set

Parameters:

text - A text string for its label.

graphic - the icon for its label.

miniIcon - the mini icon shown in front of the button

Method Detail

miniIconProperty

public final javafx.beans.property.ObjectProperty<javafx.scene.image.ImageView> miniIconProperty()

The property of the mini icon

See Also:

getMiniIcon(), setMiniIcon(ImageView)

setMiniIcon

public void setMiniIcon(javafx.scene.image.ImageView value)

Sets the mini icon

Parameters:

value - node for the mini icon

getMiniIcon

public javafx.scene.image.ImageView getMiniIcon()

Returns the mini icon

Returns:

animationTypeProperty

public final javafx.beans.property.ObjectProperty<MiniIconButton.AnimationType> animationTypeProperty()

The property for the animation type.

See Also:

getAnimationType(), setAnimationType(AnimationType)

getAnimationType

public MiniIconButton.AnimationType getAnimationType()

Returns the animation type. The default is AnimationType.NONE

Returns:

the animation type

See Also:

MiniIconButton.AnimationType

setAnimationType

public void setAnimationType(MiniIconButton.AnimationType value)

Sets the animation type.

Parameters:

value -

See Also:

MiniIconButton.AnimationType

miniIconPositionProperty

public final javafx.beans.property.ObjectProperty<javafx.geometry.Pos> miniIconPositionProperty()

The mini-icon can be positioned with <code>Pos</code>

See Also:

getMiniIconPosition(), setMiniIconPosition(Pos)

setMiniIconPosition

public final void setMiniIconPosition(javafx.geometry.Pos value)

Sets the position of the mini icon with <code>Pos</code>

Parameters:

value - position of the mini-icon

getMiniIconPosition

public final javafx.geometry.Pos getMiniIconPosition()

Returns the position of the mini-icon based on <code>Pos</code>

Returns:

position of the mini-icon

miniIconRatioProperty

public final javafx.beans.property.DoubleProperty miniIconRatioProperty()

This is the ratio of the mini-icon corresponding to the button. It could be a double number between 0.01 and 1.0.

See Also:

getMiniIconRatio(), setMiniIconRatio(double)

setMiniIconRatio

public final void setMiniIconRatio(double value)

Sets the ratio of the mini-icon corresponding to the buttons size

Parameters:

value - could be a double number between 0.01 and 1.0 all others will be set to 0.01 or 1.0

getMiniIconRatio

public final double getMiniIconRatio()

Returns the value of the mini-icon ratio. The default is 0.25

Returns:

the default value is 0.25

animationDurationProperty

public final javafx.beans.property.DoubleProperty animationDurationProperty()

This is the duration in milliseconds for the two animation types AnimationType.BLINK and AnimationType.JUMP the default is 500

See Also:

getAnimationDuration(), setAnimationDuration(double)

setAnimationDuration

public final void setAnimationDuration(double value)

Sets the animation duration in milli seconds

Parameters:

value - animation duration in milliseconds

getAnimationDuration

public final double getAnimationDuration()

Returns the duration in milliseconds for the two animation types AnimationType.BLINK and AnimationType.JUMP the default is 500

Returns:

animation duration in milliseconds, the default is 500

getUserAgentStylesheet

protected java.lang.String getUserAgentStylesheet()

Overrides:

getUserAgentStylesheet in class javafx.scene.control.Control