Class YearMonthView

java.lang.Object
javafx.scene.Node
javafx.scene.Parent
javafx.scene.layout.Region
javafx.scene.control.Control
com.dlsc.gemsfx.YearMonthView
All Implemented Interfaces:
javafx.css.Styleable, javafx.event.EventTarget, javafx.scene.control.Skinnable
public class YearMonthView extends javafx.scene.control.Control
A view for displaying and selecting year-month values.

CSS Styleable Properties:

CSS Properties
PropertyTypeDescription
-fx-show-yearBooleanWhether to show the year at the top.

  • Property Summary

    Properties
    Type
    Property
    Description
    final javafx.beans.property.ObjectProperty<javafx.util.StringConverter<Month>>
    converter
    Stores the converter used to format the month names shown by the view.
    final javafx.beans.property.ObjectProperty<YearMonth>
    earliestMonth
    Determines the earliest month that the user can select in the view.
    final javafx.beans.property.ObjectProperty<YearMonth>
    latestMonth
    Determines the latest month that the user can select in the view.
    final javafx.beans.property.BooleanProperty
    showYear
    Determines if the view willl display the current year at the top or not.
    final javafx.beans.property.ObjectProperty<YearMonth>
    value
    Stores the selected year and month.

    Properties inherited from class javafx.scene.control.Control

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

    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, 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, viewOrder, visible

  • Field Summary

    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
    Description
    YearMonthView()
    Constructs a new year-month view.

  • Method Summary

    Modifier and Type
    Method
    Description
    final javafx.beans.property.ObjectProperty<javafx.util.StringConverter<Month>>
    converterProperty()
    Stores the converter used to format the month names shown by the view.
    protected javafx.scene.control.Skin<?>
    createDefaultSkin()
    final javafx.beans.property.ObjectProperty<YearMonth>
    earliestMonthProperty()
    Determines the earliest month that the user can select in the view.
    static List<javafx.css.CssMetaData<? extends javafx.css.Styleable, ?>>
    getClassCssMetaData()
    Returns the CSS metadata supported by this control.
    List<javafx.css.CssMetaData<? extends javafx.css.Styleable, ?>>
    getControlCssMetaData()
    final javafx.util.StringConverter<Month>
    getConverter()
    Gets the value of the converter property.
    final YearMonth
    getEarliestMonth()
    Gets the value of the earliestMonth property.
    final YearMonth
    getLatestMonth()
    Gets the value of the latestMonth property.
    String
    getUserAgentStylesheet()
    final YearMonth
    getValue()
    Gets the value of the value property.
    final boolean
    isShowYear()
    Gets the value of the showYear property.
    final javafx.beans.property.ObjectProperty<YearMonth>
    latestMonthProperty()
    Determines the latest month that the user can select in the view.
    final void
    setConverter(javafx.util.StringConverter<Month> converter)
    Sets the value of the converter property.
    final void
    setEarliestMonth(YearMonth earliestMonth)
    Sets the value of the earliestMonth property.
    final void
    setLatestMonth(YearMonth latestMonth)
    Sets the value of the latestMonth property.
    final void
    setShowYear(boolean showYear)
    Sets the value of the showYear property.
    final void
    setValue(YearMonth value)
    Sets the value of the value property.
    final javafx.beans.property.BooleanProperty
    showYearProperty()
    Determines if the view willl display the current year at the top or not.
    final javafx.beans.property.ObjectProperty<YearMonth>
    valueProperty()
    Stores the selected year and month.

    Methods inherited from class javafx.scene.control.Control

    computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, contextMenuProperty, executeAccessibleAction, getBaselineOffset, getContextMenu, getCssMetaData, getInitialFocusTraversable, getSkin, getTooltip, isResizable, layoutChildren, queryAccessibleAttribute, setContextMenu, setSkin, setTooltip, 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, 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, snapPositionX, snapPositionY, snapSize, snapSizeX, snapSizeY, snapSpace, snapSpaceX, snapSpaceY, snapToPixelProperty, widthProperty

    Methods inherited from class javafx.scene.Parent

    getChildren, getChildrenUnmodifiable, getManagedChildren, getStylesheets, isNeedsLayout, layout, lookup, needsLayoutProperty, requestLayout, requestParentLayout, 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, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInitialCursor, 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, getViewOrder, hasProperties, hoverProperty, idProperty, 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, setViewOrder, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, viewOrderProperty, visibleProperty

    Methods inherited from class Object

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

    Methods inherited from interface javafx.css.Styleable

    getStyleableNode

  • Property Details

  • Constructor Details

    • YearMonthView

      public YearMonthView()
      Constructs a new year-month view.

  • Method Details

    • createDefaultSkin

      protected javafx.scene.control.Skin<?> createDefaultSkin()
      Overrides:
      createDefaultSkin in class javafx.scene.control.Control
      Returns:
      the default skin

    • getUserAgentStylesheet

      public String getUserAgentStylesheet()
      Overrides:
      getUserAgentStylesheet in class javafx.scene.layout.Region
      Returns:
      the user agent stylesheet

    • isShowYear

      public final boolean isShowYear()
      Gets the value of the showYear property.
      Property description:
      Determines if the view willl display the current year at the top or not. When this control is used standalone, then showing the year is usually necessary. If the control is part of a more complex control like the CalendarView then showing the year might not be needed as it becomes obvious from the overall context.

      Can be set via CSS using the -fx-show-year property. Valid values are: true, false. The default value is true.

      Returns:
      the value of the showYear property
      See Also:

    • showYearProperty

      public final javafx.beans.property.BooleanProperty showYearProperty()
      Determines if the view willl display the current year at the top or not. When this control is used standalone, then showing the year is usually necessary. If the control is part of a more complex control like the CalendarView then showing the year might not be needed as it becomes obvious from the overall context.

      Can be set via CSS using the -fx-show-year property. Valid values are: true, false. The default value is true.

      Returns:
      true if the year will be shown
      See Also:

    • setShowYear

      public final void setShowYear(boolean showYear)
      Sets the value of the showYear property.
      Property description:
      Determines if the view willl display the current year at the top or not. When this control is used standalone, then showing the year is usually necessary. If the control is part of a more complex control like the CalendarView then showing the year might not be needed as it becomes obvious from the overall context.

      Can be set via CSS using the -fx-show-year property. Valid values are: true, false. The default value is true.

      Parameters:
      showYear - the value for the showYear property
      See Also:

    • getClassCssMetaData

      public static List<javafx.css.CssMetaData<? extends javafx.css.Styleable, ?>> getClassCssMetaData()
      Returns the CSS metadata supported by this control.
      Returns:
      the CSS metadata supported by this control

    • getControlCssMetaData

      public List<javafx.css.CssMetaData<? extends javafx.css.Styleable, ?>> getControlCssMetaData()
      Overrides:
      getControlCssMetaData in class javafx.scene.control.Control
      Returns:
      the supported CSS metadata

    • getValue

      public final YearMonth getValue()
      Gets the value of the value property.
      Property description:
      Stores the selected year and month.
      Returns:
      the value of the value property
      See Also:

    • valueProperty

      public final javafx.beans.property.ObjectProperty<YearMonth> valueProperty()
      Stores the selected year and month.
      Returns:
      the selected year-month property
      See Also:

    • setValue

      public final void setValue(YearMonth value)
      Sets the value of the value property.
      Property description:
      Stores the selected year and month.
      Parameters:
      value - the value for the value property
      See Also:

    • getConverter

      public final javafx.util.StringConverter<Month> getConverter()
      Gets the value of the converter property.
      Property description:
      Stores the converter used to format the month names shown by the view.
      Returns:
      the value of the converter property
      See Also:

    • converterProperty

      public final javafx.beans.property.ObjectProperty<javafx.util.StringConverter<Month>> converterProperty()
      Stores the converter used to format the month names shown by the view.
      Returns:
      the month converter property
      See Also:

    • setConverter

      public final void setConverter(javafx.util.StringConverter<Month> converter)
      Sets the value of the converter property.
      Property description:
      Stores the converter used to format the month names shown by the view.
      Parameters:
      converter - the value for the converter property
      See Also:

    • getEarliestMonth

      public final YearMonth getEarliestMonth()
      Gets the value of the earliestMonth property.
      Property description:
      Determines the earliest month that the user can select in the view.
      Returns:
      the value of the earliestMonth property
      See Also:

    • earliestMonthProperty

      public final javafx.beans.property.ObjectProperty<YearMonth> earliestMonthProperty()
      Determines the earliest month that the user can select in the view.
      Returns:
      the earliest selectable month
      See Also:

    • setEarliestMonth

      public final void setEarliestMonth(YearMonth earliestMonth)
      Sets the value of the earliestMonth property.
      Property description:
      Determines the earliest month that the user can select in the view.
      Parameters:
      earliestMonth - the value for the earliestMonth property
      See Also:

    • getLatestMonth

      public final YearMonth getLatestMonth()
      Gets the value of the latestMonth property.
      Property description:
      Determines the latest month that the user can select in the view.
      Returns:
      the value of the latestMonth property
      See Also:

    • latestMonthProperty

      public final javafx.beans.property.ObjectProperty<YearMonth> latestMonthProperty()
      Determines the latest month that the user can select in the view.
      Returns:
      the latest selectable month
      See Also:

    • setLatestMonth

      public final void setLatestMonth(YearMonth latestMonth)
      Sets the value of the latestMonth property.
      Property description:
      Determines the latest month that the user can select in the view.
      Parameters:
      latestMonth - the value for the latestMonth property
      See Also: