Overview
Package
Class
Use
Tree
Deprecated
Index
All Classes
Help
Prev Class
Next Class
VAquaRendering - Release 1
Class org.violetlib.jnr.aqua.AquaUILayoutInfo
Inherited members: ShowHide
Deprecated: ShowHide
org.violetlib.jnr.aqua

Class AquaUILayoutInfo

  • Object
    • AquaUILayoutInfo
  • public abstract class AquaUILayoutInfo extends Object
    Provides layout information for widgets based on the platform UI.
    • Constructors 
      Constructor and Description
      Ordinary member indicator AquaUILayoutInfo Reveal DetailHide Detail
      AquaUILayoutInfo()
       
      public AquaUILayoutInfo()
    • Methods 
      Modifier and Type Method and Description
      Ordinary member indicator getButtonLabelInsets Reveal DetailHide Detail
      abstract Insetter getButtonLabelInsets(ButtonLayoutConfiguration g)
      Indicate where a button label should be painted, based on the specified parameters.
      @Nullable public abstract Insetter getButtonLabelInsets(@NotNull ButtonLayoutConfiguration g)
      Indicate where a button label should be painted, based on the specified parameters.
      Parameters:
      g - This parameter specifies the layout configuration of the button.
      Returns:
      an insetter that can be used to determine the label area, or null if the button has no label area.
      Ordinary member indicator getCancelButtonInsets Reveal DetailHide Detail
      abstract Insetter getCancelButtonInsets(TextFieldLayoutConfiguration g)
      Return the insets that define the active area corresponding to the cancel button in a search field.
      @Nullable public abstract Insetter getCancelButtonInsets(@NotNull TextFieldLayoutConfiguration g)
      Return the insets that define the active area corresponding to the cancel button in a search field.
      Parameters:
      g - This parameter specifies the layout configuration of the search field.
      Returns:
      the insets, or null if there is no cancel button in the specified configuration.
      Ordinary member indicator getCancelButtonLayoutInfo Reveal DetailHide Detail
      abstract LayoutInfo getCancelButtonLayoutInfo(TextFieldLayoutConfiguration g)
      Return the layout info for the cancel button in a search field.
      @Nullable public abstract LayoutInfo getCancelButtonLayoutInfo(@NotNull TextFieldLayoutConfiguration g)
      Return the layout info for the cancel button in a search field.
      Parameters:
      g - This parameter specifies the layout configuration of the search field.
      Returns:
      the layout info, or null if there is no cancel button in the specified configuration.
      Ordinary member indicator getCancelButtonPaintingInsets Reveal DetailHide Detail
      abstract Insetter getCancelButtonPaintingInsets(TextFieldLayoutConfiguration g)
      Return the insets that define the cancel button rendering region in a search field.
      @Nullable public abstract Insetter getCancelButtonPaintingInsets(@NotNull TextFieldLayoutConfiguration g)
      Return the insets that define the cancel button rendering region in a search field.
      Parameters:
      g - This parameter specifies the layout configuration of the search field.
      Returns:
      the insets, or null if there is no cancel button in the specified configuration.
      Ordinary member indicator getComboBoxEditorInsets Reveal DetailHide Detail
      abstract Insetter getComboBoxEditorInsets(ComboBoxLayoutConfiguration g)
      Return the insets that define the editor area in a properly sized combo box.
      @NotNull public abstract Insetter getComboBoxEditorInsets(@NotNull ComboBoxLayoutConfiguration g)
      Return the insets that define the editor area in a properly sized combo box.
      Parameters:
      g - This parameter specifies the layout configuration of the segmented button.
      Returns:
      the insets.
      Ordinary member indicator getComboBoxIndicatorInsets Reveal DetailHide Detail
      abstract Insetter getComboBoxIndicatorInsets(ComboBoxLayoutConfiguration g)
      Return the (dynamic) insets of the indicator within the combo box.
      @NotNull public abstract Insetter getComboBoxIndicatorInsets(@NotNull ComboBoxLayoutConfiguration g)
      Return the (dynamic) insets of the indicator within the combo box.
      Parameters:
      g - This parameter specifies the layout configuration of the segmented button.
      Returns:
      the insets.
      Ordinary member indicator getContentInsets Reveal DetailHide Detail
      Insetter getContentInsets(LayoutConfiguration g)
      Return the content insets for the specified widget configuration.
      @Nullable public Insetter getContentInsets(@NotNull LayoutConfiguration g)
      Return the content insets for the specified widget configuration.
      Parameters:
      g - The configuration.
      Returns:
      the content insets, or null if the specified configuration does not support contents.
      Ordinary member indicator getLayoutInfo Reveal DetailHide Detail
      LayoutInfo getLayoutInfo(LayoutConfiguration g)
      Return the layout information for the specified widget configuration.
      @NotNull public LayoutInfo getLayoutInfo(@NotNull LayoutConfiguration g) throws UnsupportedOperationException
      Return the layout information for the specified widget configuration.
      Parameters:
      g - The configuration.
      Returns:
      the layout information for the specified configuration.
      Throws:
      UnsupportedOperationException
      Ordinary member indicator getPopUpArrowInsets Reveal DetailHide Detail
      abstract Insetter getPopUpArrowInsets(PopupButtonConfiguration g)
      Return the insets that define the arrow area in a properly sized pop up button.
      @NotNull public abstract Insetter getPopUpArrowInsets(@NotNull PopupButtonConfiguration g)
      Return the insets that define the arrow area in a properly sized pop up button. For internal use.
      Parameters:
      g - This parameter specifies the layout configuration of the pop up button.
      Returns:
      the insets.
      Ordinary member indicator getPopupButtonContentInsets Reveal DetailHide Detail
      abstract Insetter getPopupButtonContentInsets(PopupButtonLayoutConfiguration g)
      Return the insets that define the content area in a properly sized pop up button.
      @NotNull public abstract Insetter getPopupButtonContentInsets(@NotNull PopupButtonLayoutConfiguration g)
      Return the insets that define the content area in a properly sized pop up button.
      Parameters:
      g - This parameter specifies the layout configuration of the pop up button.
      Returns:
      the insets.
      Ordinary member indicator getScrollBarThumbBounds Reveal DetailHide Detail
      abstract Rectangle2D getScrollBarThumbBounds(Rectangle2D bounds, ScrollBarConfiguration g)
      Determine the visible bounds of a scroll bar thumb.
      @NotNull public abstract Rectangle2D getScrollBarThumbBounds(@NotNull Rectangle2D bounds, @NotNull ScrollBarConfiguration g)
      Determine the visible bounds of a scroll bar thumb. This method takes into account any minimum scroll bar thumb length.
      Parameters:
      bounds - The bounds of the scroll bar.
      g - This parameter describes the scroll bar.
      Returns:
      the visible bounds of the scroll bar thumb.
      Ordinary member indicator getScrollBarThumbHit Reveal DetailHide Detail
      abstract int getScrollBarThumbHit(Rectangle2D bounds, ScrollBarThumbConfiguration g)
      Determine whether a major axis coordinate of a scroll bar corresponds to the visible thumb.
      public abstract int getScrollBarThumbHit(@NotNull Rectangle2D bounds, @NotNull ScrollBarThumbConfiguration g)
      Determine whether a major axis coordinate of a scroll bar corresponds to the visible thumb.
      Parameters:
      bounds - The bounds of the scroll bar.
      g - This parameter describes the scroll bar and the coordinate.
      Returns:
      zero if the coordinate corresponds to the visible thumb, -1 if it is in the track at a lower position, 1 if it is in the track at a higher position, a large negative number otherwise. The scroll bar track is the portion of the widget that the thumb can occupy.
      Ordinary member indicator getScrollBarThumbPosition Reveal DetailHide Detail
      abstract float getScrollBarThumbPosition(Rectangle2D bounds, ScrollBarThumbLayoutConfiguration g, boolean useExtent)
      Map a major axis coordinate of a scroll bar to a thumb position along the scroll bar track.
      public abstract float getScrollBarThumbPosition(@NotNull Rectangle2D bounds, @NotNull ScrollBarThumbLayoutConfiguration g, boolean useExtent)
      Map a major axis coordinate of a scroll bar to a thumb position along the scroll bar track.
      Parameters:
      bounds - The bounds of the scroll bar.
      g - This parameter describes the scroll bar and the coordinate.
      useExtent - If true, the coordinate is interpreted as the location of the leading edge of the thumb, for the purpose of repositioning the thumb. If false, the coordinate is interpreted as a fraction of the full track, for the purpose of scroll-to-here.
      Returns:
      the thumb position as a fraction of the scroll bar track, if in the range 0 to 1 (inclusive), or a value less than 0 if the coordinate is outside the track in the area corresponding to low values, or a value greater than 1 if the coordinate is outside the track in the area corresponding to high values. The scroll bar track is the portion of the widget that the thumb can occupy.
      Ordinary member indicator getSearchButtonInsets Reveal DetailHide Detail
      abstract Insetter getSearchButtonInsets(TextFieldLayoutConfiguration g)
      Return the insets that define the active area corresponding to the search button in a search field.
      @Nullable public abstract Insetter getSearchButtonInsets(@NotNull TextFieldLayoutConfiguration g)
      Return the insets that define the active area corresponding to the search button in a search field.
      Parameters:
      g - This parameter specifies the layout configuration of the search field.
      Returns:
      the insets, or null if there is no search button in the specified configuration.
      Ordinary member indicator getSearchButtonLayoutInfo Reveal DetailHide Detail
      abstract LayoutInfo getSearchButtonLayoutInfo(TextFieldLayoutConfiguration g)
      Return the layout info for the search button in a search field.
      @Nullable public abstract LayoutInfo getSearchButtonLayoutInfo(@NotNull TextFieldLayoutConfiguration g)
      Return the layout info for the search button in a search field.
      Parameters:
      g - This parameter specifies the layout configuration of the search field.
      Returns:
      the layout info, or null if there is no search button in the specified configuration.
      Ordinary member indicator getSearchButtonPaintingInsets Reveal DetailHide Detail
      abstract Insetter getSearchButtonPaintingInsets(TextFieldLayoutConfiguration g)
      Return the insets that define the search button rendering region in a search field.
      @Nullable public abstract Insetter getSearchButtonPaintingInsets(@NotNull TextFieldLayoutConfiguration g)
      Return the insets that define the search button rendering region in a search field.
      Parameters:
      g - This parameter specifies the layout configuration of the search field.
      Returns:
      the insets, or null if there is no search button in the specified configuration.
      Ordinary member indicator getSegmentedButtonLabelInsets Reveal DetailHide Detail
      abstract Insetter getSegmentedButtonLabelInsets(SegmentedButtonLayoutConfiguration g)
      Indicate where a segmented button label should be painted, based on the specified parameters.
      @NotNull public abstract Insetter getSegmentedButtonLabelInsets(@NotNull SegmentedButtonLayoutConfiguration g)
      Indicate where a segmented button label should be painted, based on the specified parameters.
      Parameters:
      g - This parameter specifies the layout configuration of the segmented button.
      Returns:
      an insetter that can be used to determine the label area, or null if the button has no label area.
      Ordinary member indicator getSliderLabelBounds Reveal DetailHide Detail
      abstract Rectangle2D getSliderLabelBounds(Rectangle2D bounds, SliderLayoutConfiguration g, double thumbPosition, Dimension labelSize)
      Return the suggested region for painting a label next to a slider.
      @NotNull public abstract Rectangle2D getSliderLabelBounds(@NotNull Rectangle2D bounds, @NotNull SliderLayoutConfiguration g, double thumbPosition, @NotNull Dimension labelSize)
      Return the suggested region for painting a label next to a slider.
      Parameters:
      bounds - The slider bounds.
      g - The slider layout configuration.
      thumbPosition - The thumb position associated with the label.
      labelSize - The size of the label.
      Returns:
      the bounds of the suggested label region.
      Ordinary member indicator getSliderThumbBounds Reveal DetailHide Detail
      abstract Rectangle2D getSliderThumbBounds(Rectangle2D bounds, SliderLayoutConfiguration g, double thumbPosition)
      Return the bounds of the thumb of a slider for the purposes of hit detection.
      @NotNull public abstract Rectangle2D getSliderThumbBounds(@NotNull Rectangle2D bounds, @NotNull SliderLayoutConfiguration g, double thumbPosition)
      Return the bounds of the thumb of a slider for the purposes of hit detection.
      Parameters:
      bounds - The bounds of the slider.
      g - The slider layout configuration.
      thumbPosition - The thumb position.
      Returns:
      the thumb insets.
      Ordinary member indicator getSliderThumbCenter Reveal DetailHide Detail
      abstract double getSliderThumbCenter(Rectangle2D bounds, SliderLayoutConfiguration g, double thumbPosition)
      Return the location along the major axis of the center of the thumb for a given thumb position.
      public abstract double getSliderThumbCenter(@NotNull Rectangle2D bounds, @NotNull SliderLayoutConfiguration g, double thumbPosition)
      Return the location along the major axis of the center of the thumb for a given thumb position. This method is appropriate only for linear sliders.
      Parameters:
      bounds - The slider bounds.
      g - The slider layout configuration.
      thumbPosition - The thumb position.
      Returns:
      the X coordinate of the thumb center, if the slider is horizontal, or the Y coordinate of the thumb center, if the slider is vertical.
      Ordinary member indicator getSliderThumbInsets Reveal DetailHide Detail
      abstract Insetter getSliderThumbInsets(SliderLayoutConfiguration g, double thumbPosition)
      Return the insets of the thumb of a slider for the purposes of outlining or highlighting.
      @NotNull public abstract Insetter getSliderThumbInsets(@NotNull SliderLayoutConfiguration g, double thumbPosition)
      Return the insets of the thumb of a slider for the purposes of outlining or highlighting. The returned insets do not include shadow areas.
      Parameters:
      g - The slider layout configuration.
      thumbPosition - The thumb position.
      Returns:
      the thumb insets.
      Ordinary member indicator getSliderThumbLayoutInfo Reveal DetailHide Detail
      abstract LayoutInfo getSliderThumbLayoutInfo(SliderLayoutConfiguration g)
      Return the layout info for the thumb of a slider.
      @NotNull public abstract LayoutInfo getSliderThumbLayoutInfo(@NotNull SliderLayoutConfiguration g)
      Return the layout info for the thumb of a slider.
      Parameters:
      g - This parameter specifies the layout configuration of the slider.
      Returns:
      the layout info.
      Ordinary member indicator getSliderThumbPaintingInsets Reveal DetailHide Detail
      abstract Insetter getSliderThumbPaintingInsets(SliderLayoutConfiguration g, double thumbPosition)
      Return the insets of the thumb of a slider for the purposes of painting the thumb.
      @NotNull public abstract Insetter getSliderThumbPaintingInsets(@NotNull SliderLayoutConfiguration g, double thumbPosition)
      Return the insets of the thumb of a slider for the purposes of painting the thumb. The returned insets include shadow areas.
      Parameters:
      g - The slider layout configuration.
      thumbPosition - The thumb position.
      Returns:
      the thumb insets.
      Ordinary member indicator getSliderThumbPosition Reveal DetailHide Detail
      abstract double getSliderThumbPosition(Rectangle2D bounds, SliderLayoutConfiguration g, int x, int y)
      Map a location in a slider to the corresponding thumb position.
      public abstract double getSliderThumbPosition(@NotNull Rectangle2D bounds, @NotNull SliderLayoutConfiguration g, int x, int y)
      Map a location in a slider to the corresponding thumb position. This method is used for hit detection.
      Parameters:
      bounds - The slider bounds.
      g - The slider layout configuration.
      x - The X coordinate of the location.
      y - The Y coordinate of the location.
      Returns:
      the thumb position corresponding to the specified location.
      Ordinary member indicator getSliderTrackPaintingInsets Reveal DetailHide Detail
      abstract Insetter getSliderTrackPaintingInsets(SliderLayoutConfiguration g)
      Return the insets of the region of a linear slider where the track is painted.
      @NotNull public abstract Insetter getSliderTrackPaintingInsets(@NotNull SliderLayoutConfiguration g)
      Return the insets of the region of a linear slider where the track is painted.
      Parameters:
      g - The slider layout configuration.
      Returns:
      the track insets.
      Ordinary member indicator getTableColumnHeaderLabelInsets Reveal DetailHide Detail
      abstract Insetter getTableColumnHeaderLabelInsets(TableColumnHeaderLayoutConfiguration g)
      Return the insets of the label area of a table header cell for the purposes of painting the label.
      @NotNull public abstract Insetter getTableColumnHeaderLabelInsets(@NotNull TableColumnHeaderLayoutConfiguration g)
      Return the insets of the label area of a table header cell for the purposes of painting the label. If the configuration does not imply the display of a sort indicator, then no space is reserved for a sort indicator.
      Parameters:
      g - The table header cell layout configuration.
      Returns:
      the label insets.
      Ordinary member indicator getTableColumnHeaderSortArrowInsets Reveal DetailHide Detail
      abstract Insetter getTableColumnHeaderSortArrowInsets(TableColumnHeaderLayoutConfiguration g)
      Return the insets of the sort indicator of a table header cell for the purposes of painting the sort indicator.
      @Nullable public abstract Insetter getTableColumnHeaderSortArrowInsets(@NotNull TableColumnHeaderLayoutConfiguration g)
      Return the insets of the sort indicator of a table header cell for the purposes of painting the sort indicator.
      Parameters:
      g - The table header cell layout configuration.
      Returns:
      the sort indicator insets, or null if no sort indicator is displayed in the specified configuration.
      Ordinary member indicator getTextFieldTextInsets Reveal DetailHide Detail
      abstract Insetter getTextFieldTextInsets(TextFieldLayoutConfiguration g)
      Return the insets that define the content area in a text field.
      @NotNull public abstract Insetter getTextFieldTextInsets(@NotNull TextFieldLayoutConfiguration g)
      Return the insets that define the content area in a text field.
      Parameters:
      g - This parameter specifies the layout configuration of the text field.
      Returns:
      the insets.
      Ordinary member indicator getTitleBarButtonInsets Reveal DetailHide Detail
      abstract Insetter getTitleBarButtonInsets(TitleBarLayoutConfiguration g, AquaUIPainter.TitleBarButtonWidget bw)
      Return the insets of a title bar button.
      @NotNull public abstract Insetter getTitleBarButtonInsets(@NotNull TitleBarLayoutConfiguration g, @NotNull AquaUIPainter.TitleBarButtonWidget bw)
      Return the insets of a title bar button.
      Parameters:
      g - The title bar layout configuration.
      bw - The title bar button widget that indicates which button is specified.
      Returns:
      the button insets.
      Ordinary member indicator getTitleBarButtonShape Reveal DetailHide Detail
      abstract Shape getTitleBarButtonShape(Rectangle2D bounds, TitleBarLayoutConfiguration g, AquaUIPainter.TitleBarButtonWidget bw)
      Return the shape of a title bar button, for painting.
      @NotNull public abstract Shape getTitleBarButtonShape(@NotNull Rectangle2D bounds, @NotNull TitleBarLayoutConfiguration g, @NotNull AquaUIPainter.TitleBarButtonWidget bw)
      Return the shape of a title bar button, for painting. This method is for internal use.
      Parameters:
      bounds - The title bar bounds.
      g - The title bar layout configuration.
      bw - The title bar button widget that indicates which button is specified.
      Returns:
      the button shape.
      Ordinary member indicator getTitleBarLabelInsets Reveal DetailHide Detail
      abstract Insetter getTitleBarLabelInsets(TitleBarLayoutConfiguration g)
      Return the insets of the title bar label area.
      @Nullable public abstract Insetter getTitleBarLabelInsets(@NotNull TitleBarLayoutConfiguration g)
      Return the insets of the title bar label area. The label area is used for the window title and icon.
      Parameters:
      g - The title bar layout configuration.
      Returns:
      the label area insets.
      Ordinary member indicator identifyTitleBarButton Reveal DetailHide Detail
      abstract AquaUIPainter.TitleBarButtonWidget identifyTitleBarButton(Rectangle2D bounds, TitleBarLayoutConfiguration g, int x, int y)
      Map a location in a title bar to the corresponding button.
      @Nullable public abstract AquaUIPainter.TitleBarButtonWidget identifyTitleBarButton(@NotNull Rectangle2D bounds, @NotNull TitleBarLayoutConfiguration g, int x, int y)
      Map a location in a title bar to the corresponding button. This method is used for hit detection.
      Parameters:
      bounds - The title bar bounds.
      g - The title bar layout configuration.
      x - The X coordinate of the location.
      y - The Y coordinate of the location.
      Returns:
      the widget that identifies the button corresponding to the specified location, or null if the location does not correspond to a button.
      • Methods inherited from class Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait