org.controlsfx.glyphfont

Class Glyph

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.control.Control

javafx.scene.control.Labeled

javafx.scene.control.Label

org.controlsfx.glyphfont.Glyph

All Implemented Interfaces:

javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable, Duplicatable<Glyph>

public class Glyph
extends javafx.scene.control.Label
implements Duplicatable<Glyph>

Represents one glyph from the font. The glyph is actually a label showing one character from the specified font. It can be used as 'graphic' on any UI control or Action. It can also directly be used in FXML. Examples:

 new Button("", new Glyph("FontAwesome", "BEER"))
 

 new Button("", new Glyph("FontAwesome", FontAwesome.Glyph.BEER))
 

Thy Glyph-Class also offers a fluent API to customize the look of the Glyph. For example, you can set the color color(javafx.scene.paint.Color) or also add effects such as useHoverEffect()

An ability to retrieve glyph node by combination of font name and glyph name extends to the ActionProxy graphic attribute, where the "font>" prefix should be used. For more information see ActionProxy.

Property Summary

Type	Property and Description
javafx.beans.property.ObjectProperty<java.lang.Object>	icon The icon name property.

Properties inherited from class javafx.scene.control.Label

labelFor

Properties inherited from class javafx.scene.control.Labeled

alignment, contentDisplay, ellipsisString, font, graphic, graphicTextGap, labelPadding, lineSpacing, mnemonicParsing, textAlignment, textFill, textOverrun, text, underline, wrapText

Properties inherited from class javafx.scene.control.Control

contextMenu, skinClassName, skin, tooltip

Properties inherited from class javafx.scene.layout.Region

background, border, cacheShape, centerShape, height, insets, maxHeight, maxWidth, minHeight, minWidth, opaqueInsets, padding, prefHeight, prefWidth, scaleShape, shape, snapToPixel, width

Properties inherited from class javafx.scene.Parent

impl_traversalEngine, needsLayout

Properties inherited from class javafx.scene.Node

accessibleHelp, accessibleRoleDescription, accessibleRole, accessibleText, blendMode, boundsInLocal, boundsInParent, cacheHint, cache, clip, cursor, depthTest, disabled, disable, effectiveNodeOrientation, effect, eventDispatcher, focused, focusTraversable, hover, id, impl_showMnemonics, impl_treeVisible, inputMethodRequests, layoutBounds, layoutX, layoutY, localToParentTransform, localToSceneTransform, managed, mouseTransparent, nodeOrientation, onContextMenuRequested, onDragDetected, onDragDone, onDragDropped, onDragEntered, onDragExited, onDragOver, onInputMethodTextChanged, onKeyPressed, onKeyReleased, onKeyTyped, onMouseClicked, onMouseDragEntered, onMouseDragExited, onMouseDragged, onMouseDragOver, onMouseDragReleased, onMouseEntered, onMouseExited, onMouseMoved, onMousePressed, onMouseReleased, onRotate, onRotationFinished, onRotationStarted, onScrollFinished, onScroll, onScrollStarted, onSwipeDown, onSwipeLeft, onSwipeRight, onSwipeUp, onTouchMoved, onTouchPressed, onTouchReleased, onTouchStationary, onZoomFinished, onZoom, onZoomStarted, opacity, parent, pickOnBounds, pressed, rotate, rotationAxis, scaleX, scaleY, scaleZ, scene, style, translateX, translateY, translateZ, visible

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_CSS_CLASS * Private fields * *
static java.lang.String	STYLE_GRADIENT
static java.lang.String	STYLE_HOVER_EFFECT

Fields inherited from class javafx.scene.layout.Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Fields inherited from class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Constructors

Constructor and Description
Glyph() Empty Constructor (used by FXML)
Glyph(java.lang.String fontFamily, char unicode) Creates a new Glyph
Glyph(java.lang.String fontFamily, java.lang.Object icon) Creates a new Glyph

Method Summary

Modifier and Type	Method and Description
Glyph	color(javafx.scene.paint.Color color) Sets the glyph color
static Glyph	create(java.lang.String fontAndGlyph) Retrieve glyph by font name and glyph name using one string where font name an glyph name are separated by pipe.
Glyph	duplicate() Allows glyph duplication.
Glyph	fontFamily(java.lang.String fontFamily) Sets the glyph icon font family
java.lang.String	getFontFamily() Gets the font family of this glyph
double	getFontSize() Gets the font size of this glyph
java.lang.Object	getIcon() Gets the value of the property icon.
javafx.beans.property.ObjectProperty<java.lang.Object>	iconProperty() The icon name property.
void	setColor(javafx.scene.paint.Color color) Set the Color of this Glyph
void	setFontFamily(java.lang.String family) Sets the font family of this glyph Font size is reset to default glyph font size
void	setFontSize(double size) Sets the font size of this glyph
void	setIcon(java.lang.Object iconValue) Set the icon to display.
Glyph	size(double size) Sets glyph size
Glyph	sizeFactor(int factor) Sets glyph size using size factor based on default font size
Glyph	useGradientEffect() Adds the gradient effect style
Glyph	useHoverEffect() Adds the hover effect style

Methods inherited from class javafx.scene.control.Label

createDefaultSkin, getLabelFor, impl_cssGetFocusTraversableInitialValue, labelForProperty, setLabelFor

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, executeAccessibleAction, getBaselineOffset, getContextMenu, getCssMetaData, getSkin, getTooltip, impl_processCSS, isResizable, layoutChildren, queryAccessibleAttribute, 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, getUserAgentStylesheet, 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, updateBounds

Methods inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, 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_findStyles, 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, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, 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, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, 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

icon

public javafx.beans.property.ObjectProperty<java.lang.Object> iconProperty

The icon name property. This must either be a Glyph-Name (either string or enum value) known by the GlyphFontRegistry. Alternatively, you can directly submit a unicode character here.

See Also:

getIcon(), setIcon(Object)

Field Detail

DEFAULT_CSS_CLASS

public static final java.lang.String DEFAULT_CSS_CLASS

* Private fields * *

See Also:

Constant Field Values

STYLE_GRADIENT

public static final java.lang.String STYLE_GRADIENT

See Also:

Constant Field Values

STYLE_HOVER_EFFECT

public static final java.lang.String STYLE_HOVER_EFFECT

See Also:

Constant Field Values

Constructor Detail

Glyph

public Glyph()

Empty Constructor (used by FXML)

Glyph

public Glyph(java.lang.String fontFamily,
             char unicode)

Creates a new Glyph

Parameters:

fontFamily - The family name of the font. Example: "FontAwesome"

unicode - The Unicode character of the glyph

Glyph

public Glyph(java.lang.String fontFamily,
             java.lang.Object icon)

Creates a new Glyph

Parameters:

fontFamily - The family name of the font. Example: "FontAwesome"

icon - The icon - which can be the name (String) or Enum value. Example: FontAwesome.Glyph.BEER

Method Detail

create

public static Glyph create(java.lang.String fontAndGlyph)

Retrieve glyph by font name and glyph name using one string where font name an glyph name are separated by pipe.

Parameters:

fontAndGlyph - The font and glyph separated by a pipe. Example: "FontAwesome|STAR"

Returns:

A instance of a Glyph node

fontFamily

public Glyph fontFamily(java.lang.String fontFamily)

Sets the glyph icon font family

Parameters:

fontFamily - A font family name

Returns:

Returns this instance for fluent API

color

public Glyph color(javafx.scene.paint.Color color)

Sets the glyph color

Parameters:

color -

Returns:

Returns this instance for fluent API

size

public Glyph size(double size)

Sets glyph size

Parameters:

size -

Returns:

Returns this instance for fluent API

sizeFactor

public Glyph sizeFactor(int factor)

Sets glyph size using size factor based on default font size

Parameters:

factor -

Returns:

Returns this instance for fluent API

useHoverEffect

public Glyph useHoverEffect()

Adds the hover effect style

Returns:

Returns this instance for fluent API

useGradientEffect

public Glyph useGradientEffect()

Adds the gradient effect style

Returns:

Returns this instance for fluent API

duplicate

public Glyph duplicate()

Allows glyph duplication. Since in the JavaFX scenegraph it is not possible to insert the same Node in multiple locations at the same time, this method allows for glyph reuse in several places

Specified by:

duplicate in interface Duplicatable<Glyph>

setFontFamily

public void setFontFamily(java.lang.String family)

Sets the font family of this glyph Font size is reset to default glyph font size

getFontFamily

public java.lang.String getFontFamily()

Gets the font family of this glyph

setFontSize

public void setFontSize(double size)

Sets the font size of this glyph

getFontSize

public double getFontSize()

Gets the font size of this glyph

setColor

public void setColor(javafx.scene.paint.Color color)

Set the Color of this Glyph

iconProperty

public javafx.beans.property.ObjectProperty<java.lang.Object> iconProperty()

The icon name property. This must either be a Glyph-Name (either string or enum value) known by the GlyphFontRegistry. Alternatively, you can directly submit a unicode character here.

See Also:

getIcon(), setIcon(Object)

setIcon

public void setIcon(java.lang.Object iconValue)

Set the icon to display.

Parameters:

iconValue - This can either be the Glyph-Name, Glyph-Enum Value or a unicode character representing the sign.

getIcon

public java.lang.Object getIcon()

Gets the value of the property icon.

Property description:

The icon name property. This must either be a Glyph-Name (either string or enum value) known by the GlyphFontRegistry. Alternatively, you can directly submit a unicode character here.