APIdia Launch Partner
Top Description Fields Constructors Methods
javafx.scene.text

public final Class TabStopPolicy

extends Object
Class Inheritance
Imports
javafx.beans.property.DoubleProperty, .SimpleDoubleProperty, javafx.collections.FXCollections, .ObservableList, javafx.scene.layout.Region

The TabStopPolicy determines the tab stop positions within the text layout.
Since
25

Field Summary

Modifier and TypeField and Description
private final SimpleDoubleProperty
private final ObservableList<TabStop>

Constructor Summary

AccessConstructor and Description
public
TabStopPolicy()

Constructs a new TabStopPolicy instance, with an empty list of stops.

Method Summary

Modifier and TypeMethod and Description
public final DoubleProperty

Returns:

the default tab interval property
defaultIntervalProperty
()

Specifies the default tab stop interval for tabs beyond the last stop provided by tabStops().

public boolean
equals(Object x)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public final double
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public final void
setDefaultInterval(double value)

public final ObservableList<TabStop>

Returns:

the non-null list of tab stops
tabStops
()

The list of tab stops.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

defaultIntervalback to summary
private final SimpleDoubleProperty defaultInterval
tabStopsback to summary
private final ObservableList<TabStop> tabStops

Constructor Detail

TabStopPolicyback to summary
public TabStopPolicy()

Constructs a new TabStopPolicy instance, with an empty list of stops.

Method Detail

defaultIntervalPropertyback to summary
public final DoubleProperty defaultIntervalProperty()

Specifies the default tab stop interval for tabs beyond the last stop provided by tabStops(). This is a fixed repeating distance (in pixels) to the next tab stop computed at regular intervals relative to the leading edge of the TextFlow node.

A value of less than or equal 0 disables the default interval.

Returns:DoubleProperty

the default tab interval property

Default Value
0
equalsback to summary
public boolean equals(Object x)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations
@Override
getDefaultIntervalback to summary
public final double getDefaultInterval()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Annotations
@Override
setDefaultIntervalback to summary
public final void setDefaultInterval(double value)
tabStopsback to summary
public final ObservableList<TabStop> tabStops()

The list of tab stops.

Returns:ObservableList<TabStop>

the non-null list of tab stops