Class SkinBase<C extends Control>

protected SkinBase(C control)

Constructor for all SkinBase instances.

public final C getSkinnable()

Gets the Skinnable to which this Skin is assigned. A Skin must be created for one and only one Skinnable. This value will only ever go from a non-null to null value when the Skin is removed from the Skinnable, and only as a consequence of a call to Skin.dispose().

The caller who constructs a Skinnable must also construct a Skin and properly establish the relationship between the Control and its Skin.

public final Node getNode()

Gets the Node which represents this Skin. This must never be null, except after a call to Skin.dispose(), and must never change except when changing to null.

public void dispose()

Called when a previously installed skin is about to be removed from its associated control. This allows the skin to do clean up, like removing listeners and bindings, and undo any changes to the control's properties. After this method completes, Skin.getSkinnable() and Skin.getNode() should return null.

Calling Skin.dispose() more than once has no effect.

public final ObservableList<Node> getChildren()

Returns the children of the skin.

protected void layoutChildren(double contentX, double contentY, double contentWidth, double contentHeight)

Called during the layout pass of the scenegraph.

protected final void consumeMouseEvents(boolean value)

Determines whether all mouse events should be automatically consumed.

protected final void registerChangeListener(ObservableValue<?> observable, Consumer<ObservableValue<?>> operation)

Registers an operation to perform when the given observable sends a change event. Does nothing if either observable or operation are null. If multiple operations are registered on the same observable, they will be performed in the order in which they were registered.

protected final Consumer<ObservableValue<?>> unregisterChangeListeners(ObservableValue<?> observable)

Unregisters all operations that have been registered using registerChangeListener(ObservableValue, Consumer) for the given observable. Does nothing if observable is null.

protected final void registerInvalidationListener(Observable observable, Consumer<Observable> operation)

Registers an operation to perform when the given observable sends an invalidation event. Does nothing if either observable or operation are null. If multiple operations are registered on the same observable, they will be performed in the order in which they were registered.

protected final Consumer<Observable> unregisterInvalidationListeners(Observable observable)

Unregisters all operations that have been registered using registerInvalidationListener(Observable, Consumer) for the given observable. Does nothing if observable is null.

protected final void registerListChangeListener(ObservableList<?> observableList, Consumer<ListChangeListener.Change<?>> operation)

Registers an operation to perform when the given observableList sends a list change event. Does nothing if either observableList or operation are null. If multiple operations are registered on the same observable list, they will be performed in the order in which they were registered.

protected final Consumer<ListChangeListener.Change<?>> unregisterListChangeListeners(ObservableList<?> observableList)

Unregisters all operations that have been registered using registerListChangeListener(ObservableList, Consumer) for the given observableList. Does nothing if observableList is null.

protected double computeMinWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)

Computes the minimum allowable width of the Skin, based on the provided height.

protected double computeMinHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)

Computes the minimum allowable height of the Skin, based on the provided width.

protected double computeMaxWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)

Computes the maximum allowable width of the Skin, based on the provided height.

protected double computeMaxHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)

Computes the maximum allowable height of the Skin, based on the provided width.

protected double computePrefWidth(double height, double topInset, double rightInset, double bottomInset, double leftInset)

Calculates the preferred width of this SkinBase. The default implementation calculates this width as the width of the area occupied by its managed children when they are positioned at their current positions at their preferred widths.

protected double computePrefHeight(double width, double topInset, double rightInset, double bottomInset, double leftInset)

Calculates the preferred height of this SkinBase. The default implementation calculates this height as the height of the area occupied by its managed children when they are positioned at their current positions at their preferred heights.

protected double computeBaselineOffset(double topInset, double rightInset, double bottomInset, double leftInset)

Calculates the baseline offset based on the first managed child. If there is no such child, returns Node.getBaselineOffset().

protected double snappedTopInset()

Utility method to get the top inset which includes padding and border inset. Then snapped to whole pixels if getSkinnable().isSnapToPixel() is true.

protected double snappedBottomInset()

Utility method to get the bottom inset which includes padding and border inset. Then snapped to whole pixels if getSkinnable().isSnapToPixel() is true.

protected double snappedLeftInset()

Utility method to get the left inset which includes padding and border inset. Then snapped to whole pixels if getSkinnable().isSnapToPixel() is true.

protected double snappedRightInset()

Utility method to get the right inset which includes padding and border inset. Then snapped to whole pixels if getSkinnable().isSnapToPixel() is true.

@Deprecated(since="9") protected double snapSpace(double value)

If getSkinnable().isSnapToPixel() is false, this method returns the same value, else it tries to return a value rounded to the nearest pixel, but since there is no indication if the value is a vertical or horizontal measurement then it may be snapped to the wrong pixel size metric on screens with different horizontal and vertical scales.

protected double snapSpaceX(double value)

Convenience method for accessing the snapSpaceX() method on the skinnable. It is equivalent to calling getSkinnable().snapSpaceX(value).

protected double snapSpaceY(double value)

Convenience method for accessing the snapSpaceY() method on the skinnable. It is equivalent to calling getSkinnable().snapSpaceY(value).

@Deprecated(since="9") protected double snapSize(double value)

If getSkinnable().isSnapToPixel() is false, this method returns the same value, else it tries to return a value ceiled to the nearest pixel, but since there is no indication if the value is a vertical or horizontal measurement then it may be snapped to the wrong pixel size metric on screens with different horizontal and vertical scales.

protected double snapSizeX(double value)

Convenience method for accessing the snapSizeX() method on the skinnable. It is equivalent to calling getSkinnable().snapSizeX(value).

protected double snapSizeY(double value)

Convenience method for accessing the snapSizeY() method on the skinnable. It is equivalent to calling getSkinnable().snapSizeY(value).

@Deprecated(since="9") protected double snapPosition(double value)

If getSkinnable().isSnapToPixel() is false, this method returns the same value, else it tries to return a value rounded to the nearest pixel, but since there is no indication if the value is a vertical or horizontal measurement then it may be snapped to the wrong pixel size metric on screens with different horizontal and vertical scales.

protected double snapPositionX(double value)

Convenience method for accessing the snapPositionX() method on the skinnable. It is equivalent to calling getSkinnable().snapPositionX(value).

protected double snapPositionY(double value)

Convenience method for accessing the snapPositionY() method on the skinnable. It is equivalent to calling getSkinnable().snapPositionY(value).

protected void positionInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, HPos halignment, VPos valignment)

Utility method which positions the child within an area of this skin defined by areaX, areaY, areaWidth x areaHeight, with a baseline offset relative to that area.

This function does not resize the node and uses the node's layout bounds width and height to determine how it should be positioned within the area.

If the vertical alignment is VPos.BASELINE then it will position the node so that its own baseline aligns with the passed in baselineOffset, otherwise the baseline parameter is ignored.

If snapToPixel is true for this skin, then the x/y position values will be rounded to their nearest pixel boundaries.

protected void positionInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, Insets margin, HPos halignment, VPos valignment)

Utility method which positions the child within an area of this skin defined by areaX, areaY, areaWidth x areaHeight, with a baseline offset relative to that area.

This function does not resize the node and uses the node's layout bounds width and height to determine how it should be positioned within the area.

If the vertical alignment is VPos.BASELINE then it will position the node so that its own baseline aligns with the passed in baselineOffset, otherwise the baseline parameter is ignored.

If snapToPixel is true for this skin, then the x/y position values will be rounded to their nearest pixel boundaries.

If margin is non-null, then that space will be allocated around the child within the layout area. margin may be null.

protected void layoutInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, HPos halignment, VPos valignment)

Utility method which lays out the child within an area of this skin defined by areaX, areaY, areaWidth x areaHeight, with a baseline offset relative to that area.

If the child is resizable, this method will resize it to fill the specified area unless the node's maximum size prevents it. If the node's maximum size preference is less than the area size, the maximum size will be used. If node's maximum is greater than the area size, then the node will be resized to fit within the area, unless its minimum size prevents it.

If the child has a non-null contentBias, then this method will use it when resizing the child. If the contentBias is horizontal, it will set its width first to the area's width (up to the child's max width limit) and then pass that value to compute the child's height. If child's contentBias is vertical, then it will set its height to the area height (up to child's max height limit) and pass that height to compute the child's width. If the child's contentBias is null, then it's width and height have no dependencies on each other.

If the child is not resizable (Shape, Group, etc) then it will only be positioned and not resized.

If the child's resulting size differs from the area's size (either because it was not resizable or it's sizing preferences prevented it), then this function will align the node relative to the area using horizontal and vertical alignment values. If valignment is VPos.BASELINE then the node's baseline will be aligned with the area baseline offset parameter, otherwise the baseline parameter is ignored.

If snapToPixel is true for this skin, then the resulting x,y values will be rounded to their nearest pixel boundaries and the width/height values will be ceiled to the next pixel boundary.

protected void layoutInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, Insets margin, HPos halignment, VPos valignment)

Utility method which lays out the child within an area of this skin defined by areaX, areaY, areaWidth x areaHeight, with a baseline offset relative to that area.

If the child is resizable, this method will resize it to fill the specified area unless the node's maximum size prevents it. If the node's maximum size preference is less than the area size, the maximum size will be used. If node's maximum is greater than the area size, then the node will be resized to fit within the area, unless its minimum size prevents it.

If the child has a non-null contentBias, then this method will use it when resizing the child. If the contentBias is horizontal, it will set its width first to the area's width (up to the child's max width limit) and then pass that value to compute the child's height. If child's contentBias is vertical, then it will set its height to the area height (up to child's max height limit) and pass that height to compute the child's width. If the child's contentBias is null, then it's width and height have no dependencies on each other.

If the child is not resizable (Shape, Group, etc) then it will only be positioned and not resized.

If the child's resulting size differs from the area's size (either because it was not resizable or it's sizing preferences prevented it), then this function will align the node relative to the area using horizontal and vertical alignment values. If valignment is VPos.BASELINE then the node's baseline will be aligned with the area baseline offset parameter, otherwise the baseline parameter is ignored.

If margin is non-null, then that space will be allocated around the child within the layout area. margin may be null.

If snapToPixel is true for this skin, then the resulting x,y values will be rounded to their nearest pixel boundaries and the width/height values will be ceiled to the next pixel boundary.

protected void layoutInArea(Node child, double areaX, double areaY, double areaWidth, double areaHeight, double areaBaselineOffset, Insets margin, boolean fillWidth, boolean fillHeight, HPos halignment, VPos valignment)

Utility method which lays out the child within an area of this skin defined by areaX, areaY, areaWidth x areaHeight, with a baseline offset relative to that area.

If the child is resizable, this method will use fillWidth and fillHeight to determine whether to resize it to fill the area or keep the child at its preferred dimension. If fillWidth/fillHeight are true, then this method will only resize the child up to its max size limits. If the node's maximum size preference is less than the area size, the maximum size will be used. If node's maximum is greater than the area size, then the node will be resized to fit within the area, unless its minimum size prevents it.

If the child has a non-null contentBias, then this method will use it when resizing the child. If the contentBias is horizontal, it will set its width first and then pass that value to compute the child's height. If child's contentBias is vertical, then it will set its height first and pass that value to compute the child's width. If the child's contentBias is null, then it's width and height have no dependencies on each other.

If the child is not resizable (Shape, Group, etc) then it will only be positioned and not resized.

If the child's resulting size differs from the area's size (either because it was not resizable or it's sizing preferences prevented it), then this function will align the node relative to the area using horizontal and vertical alignment values. If valignment is VPos.BASELINE then the node's baseline will be aligned with the area baseline offset parameter, otherwise the baseline parameter is ignored.

If margin is non-null, then that space will be allocated around the child within the layout area. margin may be null.

If snapToPixel is true for this skin, then the resulting x,y values will be rounded to their nearest pixel boundaries and the width/height values will be ceiled to the next pixel boundary.

public static List<CssMetaData<? extends Styleable,?>> getClassCssMetaData()

Returns the CssMetaData associated with this class, which may include the CssMetaData of its superclasses.

public List<CssMetaData<? extends Styleable,?>> getCssMetaData()

This method should delegate to Node.getClassCssMetaData() so that a Node's CssMetaData can be accessed without the need for reflection.

public final void pseudoClassStateChanged(PseudoClass pseudoClass, boolean active)

Used to specify that a pseudo-class of this Node has changed. If the pseudo-class is used in a CSS selector that matches this Node, CSS will be reapplied. Typically, this method is called from the invalidated method of a property that is used as a pseudo-class. For example:

     private static final PseudoClass MY_PSEUDO_CLASS_STATE = PseudoClass.getPseudoClass("my-state");

     BooleanProperty myPseudoClassState = new BooleanPropertyBase(false) {

           @Override public void invalidated() {
                pseudoClassStateChanged(MY_PSEUDO_CLASS_STATE, get());
           }

           @Override public Object getBean() {
               return MyControl.this;
           }

           @Override public String getName() {
               return "myPseudoClassState";
           }
       };
 

protected Object queryAccessibleAttribute(AccessibleAttribute attribute, Object... parameters)

This method is called by the assistive technology to request the value for an attribute.

This method is commonly overridden by subclasses to implement attributes that are required for a specific role.
If a particular attribute is not handled, the superclass implementation must be called.

protected void executeAccessibleAction(AccessibleAction action, Object... parameters)

This method is called by the assistive technology to request the action indicated by the argument should be executed.

This method is commonly overridden by subclasses to implement action that are required for a specific role.
If a particular action is not handled, the superclass implementation must be called.