com.yworks.yfiles.graph.styles

Class LabelTemplate

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.layout.Pane

javafx.scene.layout.StackPane

com.yworks.yfiles.graph.styles.AbstractGraphItemTemplate<ILabel>

com.yworks.yfiles.graph.styles.LabelTemplate

All Implemented Interfaces:

javafx.css.Styleable, EventTarget

public class LabelTemplate
extends AbstractGraphItemTemplate<ILabel>

A template for ILabels in GraphControl that is used by com.yworks.yfiles.drawing.ITemplateLabelStyle to create the visualization of the ILabel.

Use this LabelTemplate as root element in the FXML representation of the template style.

Property Summary

Type	Property and Description
BooleanProperty	isFlipped Indicates whether or not the label was flipped when it was placed upside down with auto flipping enabled.
BooleanProperty	isUpsideDown Indicates whether the label is currently placed upside down.
StringProperty	labelText Returns a property holding the label text.

Properties inherited from class com.yworks.yfiles.graph.styles.AbstractGraphItemTemplate

canvasProperty, contentProperty, itemFocusedProperty, itemHighlightedProperty, itemProperty, itemSelectedProperty, styleTagProperty

Properties inherited from class javafx.scene.layout.StackPane

alignmentProperty

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

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, 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

Field Summary

Fields

Modifier and Type	Field and Description
protected BooleanProperty	isFlipped
protected BooleanProperty	isUpsideDown
protected StringProperty	labelText

Fields inherited from class com.yworks.yfiles.graph.styles.AbstractGraphItemTemplate

canvas, content, item, itemFocused, itemHighlighted, itemSelected, lastContentObject, styleTag

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
LabelTemplate()

Method Summary

Modifier and Type	Method and Description
boolean	getIsFlipped() Gets the value of the property isFlipped.
boolean	getIsUpsideDown() Gets the value of the property isUpsideDown.
String	getLabelText() Gets the value of property labelText.
protected void	initializeFrom(IRenderContext ctx, ILabel label, TemplateLabelStyle style) Initializes all properties with the given ILabel and style information.
void	initializeFromInternal(IRenderContext ctx, ILabel item, ILabelStyle style) Initializes this label template with the given ILabel and style information.
BooleanProperty	isFlippedProperty() Indicates whether or not the label was flipped when it was placed upside down with auto flipping enabled.
BooleanProperty	isUpsideDownProperty() Indicates whether the label is currently placed upside down.
StringProperty	labelTextProperty() Returns a property holding the label text.
void	setIsFlipped(boolean isFlipped) Sets the value of the property isFlipped.
void	setIsUpsideDown(boolean isUpsideDown) Sets the value of the property isUpsideDown.
void	setLabelText(String labelText) Sets the value of property labelText.
protected void	updateContent(TemplateLabelStyle style, ILabel label) Updates the content object the user has specified.
protected void	updateFor(IRenderContext ctx, ILabel label, TemplateLabelStyle style) Updates all properties with the given ILabel and style information.
void	updateForInternal(IRenderContext ctx, ILabel item, ILabelStyle style) Updates this label template with the given ILabel and style information.

Methods inherited from class com.yworks.yfiles.graph.styles.AbstractGraphItemTemplate

canvasProperty, contentProperty, getCanvas, getContent, getItem, getItemFocused, getItemHighlighted, getItemSelected, getStyleTag, itemFocusedProperty, itemHighlightedProperty, itemProperty, itemSelectedProperty, setCanvas, setContent, setItem, setItemFocused, setItemHighlighted, setItemSelected, setStyleTag, styleTagProperty, updateState

Methods inherited from class javafx.scene.layout.StackPane

alignmentProperty, clearConstraints, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getAlignment, getAlignment, getClassCssMetaData, getContentBias, getCssMetaData, getMargin, layoutChildren, requestLayout, setAlignment, setAlignment, setMargin

Methods inherited from class javafx.scene.layout.Pane

getChildren

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, 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, isResizable, 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

getBaselineOffset, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processCSS, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, queryAccessibleAttribute, 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, executeAccessibleAction, 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_cssGetFocusTraversableInitialValue, 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, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object

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

Property Detail

isFlipped

public final BooleanProperty isFlippedProperty

Indicates whether or not the label was flipped when it was placed upside down with auto flipping enabled.

Returns:

The IsFlippedProperty.

isUpsideDown

public final BooleanProperty isUpsideDownProperty

Indicates whether the label is currently placed upside down.

Returns:

true if the label is upside down, false otherwise.

labelText

public final StringProperty labelTextProperty

Returns a property holding the label text.

Returns:

The LabelTextProperty.

Field Detail

isFlipped

protected BooleanProperty isFlipped

isUpsideDown

protected BooleanProperty isUpsideDown

labelText

protected StringProperty labelText

Constructor Detail

LabelTemplate

public LabelTemplate()

Method Detail

getIsFlipped

public final boolean getIsFlipped()

Gets the value of the property isFlipped.

Returns:

true if the label was flipped, false otherwise.

getIsUpsideDown

public final boolean getIsUpsideDown()

Gets the value of the property isUpsideDown.

Returns:

true if the label is upside down, false otherwise.

getLabelText

public final String getLabelText()

Gets the value of property labelText.

Returns:

The text of the label.

initializeFrom

protected void initializeFrom(IRenderContext ctx,
                              ILabel label,
                              TemplateLabelStyle style)

Initializes all properties with the given ILabel and style information.

Parameters:

ctx - The rendering context.

label - The label.

style - The label style.

initializeFromInternal

public void initializeFromInternal(IRenderContext ctx,
                                   ILabel item,
                                   ILabelStyle style)

Initializes this label template with the given ILabel and style information.

Parameters:

ctx - The rendering context.

item - The model item.

style - The label style.

isFlippedProperty

public final BooleanProperty isFlippedProperty()

Indicates whether or not the label was flipped when it was placed upside down with auto flipping enabled.

Returns:

The IsFlippedProperty.

isUpsideDownProperty

public final BooleanProperty isUpsideDownProperty()

Indicates whether the label is currently placed upside down.

Returns:

true if the label is upside down, false otherwise.

labelTextProperty

public final StringProperty labelTextProperty()

Returns a property holding the label text.

Returns:

The LabelTextProperty.

setIsFlipped

public final void setIsFlipped(boolean isFlipped)

Sets the value of the property isFlipped.

Parameters:

isFlipped - true if the label is flipped, false otherwise.

setIsUpsideDown

public final void setIsUpsideDown(boolean isUpsideDown)

Sets the value of the property isUpsideDown.

Parameters:

isUpsideDown - true if the label is upside down, false otherwise.

setLabelText

public final void setLabelText(String labelText)

Sets the value of property labelText.

Parameters:

labelText - The text of the label.

updateContent

protected void updateContent(TemplateLabelStyle style,
                             ILabel label)

Updates the content object the user has specified.

Parameters:

style - The template label style.

label - The label.

updateFor

protected void updateFor(IRenderContext ctx,
                         ILabel label,
                         TemplateLabelStyle style)

Updates all properties with the given ILabel and style information.

Parameters:

ctx - The rendering context.

label - The label.

style - The label style.

updateForInternal

public void updateForInternal(IRenderContext ctx,
                              ILabel item,
                              ILabelStyle style)

Updates this label template with the given ILabel and style information.

Parameters:

ctx - The rendering context.

item - The model item.

style - The label style.