flowless 0.7.4 · org.fxmisc.flowless.VirtualizedScrollPane

Field Summary

Modifier and Type	Field and Description
private final V	content
private static final PseudoClass	CONTENT_FOCUSED
private final ChangeListener<Boolean>	contentFocusedListener
private final ScrollBar	hbar
private final Var<ScrollPane.ScrollBarPolicy>	hbarPolicy The Policy for the Horizontal ScrollBar
private Var<Double>	hbarValue
private final ChangeListener<Double>	hbarValueListener
private Var<Double>	hPosEstimate
private ChangeListener<Double>	hPosEstimateListener
private final ScrollBar	vbar
private final Var<ScrollPane.ScrollBarPolicy>	vbarPolicy The Policy for the Vertical ScrollBar
private Var<Double>	vbarValue
private final ChangeListener<Double>	vbarValueListener
private Var<Double>	vPosEstimate
private final ChangeListener<Double>	vPosEstimateListener

Inherited from javafx.scene.layout.Region:: USE_COMPUTED_SIZE USE_PREF_SIZE

Constructor Summary

Access	Constructor and Description
public	VirtualizedScrollPane(V content, ScrollPane.ScrollBarPolicy hPolicy, ScrollPane.ScrollBarPolicy vPolicy) Constructs a VirtualizedScrollPane with the given content and policies
public	VirtualizedScrollPane(V content) Constructs a VirtualizedScrollPane that only displays its horizontal and vertical scroll bars as needed

Method Summary

Modifier and Type	Method and Description
protected double	computeMaxHeight(double width) Overrides javafx.scene.layout.Region.computeMaxHeight. Computes the maximum height of this region.
protected double	computeMaxWidth(double height) Overrides javafx.scene.layout.Region.computeMaxWidth. Computes the maximum width for this region.
protected double	computeMinHeight(double width) Overrides javafx.scene.layout.Region.computeMinHeight. Computes the minimum height of this region.
protected double	computeMinWidth(double height) Overrides javafx.scene.layout.Region.computeMinWidth. Computes the minimum width of this region.
protected double	computePrefHeight(double width) Overrides javafx.scene.layout.Region.computePrefHeight. Computes the preferred height of this region for the given width; Region subclasses should override this method to return an appropriate value based on their content and layout strategy.
protected double	computePrefWidth(double height) Overrides javafx.scene.layout.Region.computePrefWidth. Computes the preferred width of this region for the given height.
private void	dispose()
public Var<Double>	estimatedScrollXProperty() Implements org.fxmisc.flowless.Virtualized.estimatedScrollXProperty.
public Var<Double>	estimatedScrollYProperty() Implements org.fxmisc.flowless.Virtualized.estimatedScrollYProperty.
public V	Returns: - the content getContent() Does not unbind scrolling from Content before returning Content.
public final ScrollPane.ScrollBarPolicy	getHbarPolicy()
public final ScrollPane.ScrollBarPolicy	getVbarPolicy()
public final Var<ScrollPane.ScrollBarPolicy>	hbarPolicyProperty()
protected void	layoutChildren() Overrides javafx.scene.Parent.layoutChildren. Invoked during the layout pass to layout the children in this `Parent`.
private static double	offsetToScrollbarPosition(double contentOffset, double viewportSize, double padding, double contentSize)
public V	Returns: - the content removeContent() Unbinds scrolling from Content before returning Content.
private static double	scrollbarPositionToOffset(double scrollbarPos, double viewportSize, double padding, double contentSize)
public void	scrollXBy(double deltaX) Implements org.fxmisc.flowless.Virtualized.scrollXBy. Scroll the content horizontally by the given amount.
public void	scrollXToPixel(double pixel) Implements org.fxmisc.flowless.Virtualized.scrollXToPixel. Scroll the content horizontally to the pixel
public void	scrollYBy(double deltaY) Implements org.fxmisc.flowless.Virtualized.scrollYBy. Scroll the content vertically by the given amount.
public void	scrollYToPixel(double pixel) Implements org.fxmisc.flowless.Virtualized.scrollYToPixel. Scroll the content vertically to the pixel
public final void	setHbarPolicy(ScrollPane.ScrollBarPolicy value)
private void	setHPosition(double pos)
private static void	setupUnitIncrement(ScrollBar bar)
public final void	setVbarPolicy(ScrollPane.ScrollBarPolicy value)
private void	setVPosition(double pos)
public Val<Double>	totalHeightEstimateProperty() Implements org.fxmisc.flowless.Virtualized.totalHeightEstimateProperty.
public Val<Double>	totalWidthEstimateProperty() Implements org.fxmisc.flowless.Virtualized.totalWidthEstimateProperty.
private void	unbindScrollBar(ScrollBar bar)
public final Var<ScrollPane.ScrollBarPolicy>	vbarPolicyProperty()

Inherited from javafx.scene.layout.Region:: backgroundProperty borderProperty cacheShapeProperty centerShapeProperty getBackground getBorder getClassCssMetaData getCssMetaData getHeight getInsets getMaxHeight getMaxWidth getMinHeight getMinWidth getOpaqueInsets getPadding getPrefHeight getPrefWidth getShape getUserAgentStylesheet getWidth heightProperty 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 snapPositionX snapPositionY snapSize snapSizeX snapSizeY snapSpace snapSpaceX snapSpaceY snapToPixelProperty widthProperty

Field Detail

content	back to summary
private final V content

CONTENT_FOCUSED	back to summary
private static final PseudoClass CONTENT_FOCUSED

contentFocusedListener	back to summary
private final ChangeListener<Boolean> contentFocusedListener

hbar	back to summary
private final ScrollBar hbar

hbarPolicy	back to summary
private final Var<ScrollPane.ScrollBarPolicy> hbarPolicy The Policy for the Horizontal ScrollBar

hbarValue	back to summary
private Var<Double> hbarValue

hbarValueListener	back to summary
private final ChangeListener<Double> hbarValueListener

hPosEstimate	back to summary
private Var<Double> hPosEstimate

hPosEstimateListener	back to summary
private ChangeListener<Double> hPosEstimateListener

vbar	back to summary
private final ScrollBar vbar

vbarPolicy	back to summary
private final Var<ScrollPane.ScrollBarPolicy> vbarPolicy The Policy for the Vertical ScrollBar

vbarValue	back to summary
private Var<Double> vbarValue

vbarValueListener	back to summary
private final ChangeListener<Double> vbarValueListener

vPosEstimate	back to summary
private Var<Double> vPosEstimate

vPosEstimateListener	back to summary
private final ChangeListener<Double> vPosEstimateListener

Constructor Detail

VirtualizedScrollPane	back to summary
public VirtualizedScrollPane(V content, ScrollPane.ScrollBarPolicy hPolicy, ScrollPane.ScrollBarPolicy vPolicy) Constructs a VirtualizedScrollPane with the given content and policies

VirtualizedScrollPane	back to summary
public VirtualizedScrollPane(V content) Constructs a VirtualizedScrollPane that only displays its horizontal and vertical scroll bars as needed

Method Detail

computeMaxHeight	back to summary
protected double computeMaxHeight(double width) Overrides javafx.scene.layout.Region.computeMaxHeight. Doc from javafx.scene.layout.Region.computeMaxHeight. Computes the maximum height of this region. Returns Double.MAX_VALUE by default. Region subclasses may override this method to return a different value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored. Annotations @Override

computeMaxHeight

back to summary

protected double computeMaxHeight(double width)

Overrides javafx.scene.layout.Region.computeMaxHeight.

Doc from javafx.scene.layout.Region.computeMaxHeight.

Computes the maximum height of this region. Returns Double.MAX_VALUE by default. Region subclasses may override this method to return a different value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored.

Annotations

@Override

computeMaxWidth	back to summary
protected double computeMaxWidth(double height) Overrides javafx.scene.layout.Region.computeMaxWidth. Doc from javafx.scene.layout.Region.computeMaxWidth. Computes the maximum width for this region. Returns Double.MAX_VALUE by default. Region subclasses may override this method to return an different value based on their content and layout strategy. If the subclass doesn't have a VERTICAL content bias, then the height parameter can be ignored. Annotations @Override

computeMaxWidth

back to summary

protected double computeMaxWidth(double height)

Overrides javafx.scene.layout.Region.computeMaxWidth.

Doc from javafx.scene.layout.Region.computeMaxWidth.

Computes the maximum width for this region. Returns Double.MAX_VALUE by default. Region subclasses may override this method to return an different value based on their content and layout strategy. If the subclass doesn't have a VERTICAL content bias, then the height parameter can be ignored.

Annotations

@Override

computeMinHeight	back to summary
protected double computeMinHeight(double width) Overrides javafx.scene.layout.Region.computeMinHeight. Doc from javafx.scene.layout.Region.computeMinHeight. Computes the minimum height of this region. Returns the sum of the top and bottom insets by default. Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored. Annotations @Override

computeMinHeight

back to summary

protected double computeMinHeight(double width)

Overrides javafx.scene.layout.Region.computeMinHeight.

Doc from javafx.scene.layout.Region.computeMinHeight.

Computes the minimum height of this region. Returns the sum of the top and bottom insets by default. Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored.

Annotations

@Override

computeMinWidth	back to summary
protected double computeMinWidth(double height) Overrides javafx.scene.layout.Region.computeMinWidth. Doc from javafx.scene.layout.Region.computeMinWidth. Computes the minimum width of this region. Returns the sum of the left and right insets by default. region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a VERTICAL content bias, then the height parameter can be ignored. Annotations @Override

computeMinWidth

back to summary

protected double computeMinWidth(double height)

Overrides javafx.scene.layout.Region.computeMinWidth.

Doc from javafx.scene.layout.Region.computeMinWidth.

Computes the minimum width of this region. Returns the sum of the left and right insets by default. region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a VERTICAL content bias, then the height parameter can be ignored.

Annotations

@Override

computePrefHeight	back to summary
protected double computePrefHeight(double width) Overrides javafx.scene.layout.Region.computePrefHeight. Doc from javafx.scene.layout.Region.computePrefHeight. Computes the preferred height of this region for the given width; Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored. Annotations @Override

computePrefHeight

back to summary

protected double computePrefHeight(double width)

Overrides javafx.scene.layout.Region.computePrefHeight.

Doc from javafx.scene.layout.Region.computePrefHeight.

Computes the preferred height of this region for the given width; Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a HORIZONTAL content bias, then the width parameter can be ignored.

Annotations

@Override

computePrefWidth	back to summary
protected double computePrefWidth(double height) Overrides javafx.scene.layout.Region.computePrefWidth. Doc from javafx.scene.layout.Region.computePrefWidth. Computes the preferred width of this region for the given height. Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a VERTICAL content bias, then the height parameter can be ignored. Annotations @Override

computePrefWidth

back to summary

protected double computePrefWidth(double height)

Overrides javafx.scene.layout.Region.computePrefWidth.

Doc from javafx.scene.layout.Region.computePrefWidth.

Computes the preferred width of this region for the given height. Region subclasses should override this method to return an appropriate value based on their content and layout strategy. If the subclass doesn't have a VERTICAL content bias, then the height parameter can be ignored.

Annotations

@Override

dispose	back to summary
private void dispose()

estimatedScrollXProperty	back to summary
public Var<Double> estimatedScrollXProperty() Implements org.fxmisc.flowless.Virtualized.estimatedScrollXProperty. Annotations @Override

estimatedScrollXProperty

back to summary

public Var<Double> estimatedScrollXProperty()

Implements org.fxmisc.flowless.Virtualized.estimatedScrollXProperty.

Annotations

@Override

estimatedScrollYProperty	back to summary
public Var<Double> estimatedScrollYProperty() Implements org.fxmisc.flowless.Virtualized.estimatedScrollYProperty. Annotations @Override

estimatedScrollYProperty

back to summary

public Var<Double> estimatedScrollYProperty()

Implements org.fxmisc.flowless.Virtualized.estimatedScrollYProperty.

Annotations

@Override

getContent	back to summary
public V getContent() Does not unbind scrolling from Content before returning Content. Returns:V - the content

getContent

back to summary

public V getContent()

Does not unbind scrolling from Content before returning Content.

Returns:V: - the content

getHbarPolicy	back to summary
public final ScrollPane.ScrollBarPolicy getHbarPolicy()

getVbarPolicy	back to summary
public final ScrollPane.ScrollBarPolicy getVbarPolicy()

hbarPolicyProperty	back to summary
public final Var<ScrollPane.ScrollBarPolicy> hbarPolicyProperty()

layoutChildren back to summary

layoutChildren	back to summary
protected void layoutChildren() Overrides javafx.scene.Parent.layoutChildren. Doc from javafx.scene.Parent.layoutChildren. Invoked during the layout pass to layout the children in this `Parent`. By default it will only set the size of managed, resizable content to their preferred sizes and does not do any node positioning. Subclasses should override this function to layout content as needed. Annotations @Override

protected void layoutChildren()

Overrides javafx.scene.Parent.layoutChildren.

Doc from javafx.scene.Parent.layoutChildren.

Invoked during the layout pass to layout the children in this Parent. By default it will only set the size of managed, resizable content to their preferred sizes and does not do any node positioning.

Subclasses should override this function to layout content as needed.

Annotations

@Override

offsetToScrollbarPosition	back to summary
private static double offsetToScrollbarPosition(double contentOffset, double viewportSize, double padding, double contentSize)

removeContent	back to summary
public V removeContent() Unbinds scrolling from Content before returning Content. Returns:V - the content

removeContent

back to summary

public V removeContent()

Unbinds scrolling from Content before returning Content.

Returns:V: - the content

scrollbarPositionToOffset	back to summary
private static double scrollbarPositionToOffset(double scrollbarPos, double viewportSize, double padding, double contentSize)

scrollXBy	back to summary
public void scrollXBy(double deltaX) Implements org.fxmisc.flowless.Virtualized.scrollXBy. Doc from org.fxmisc.flowless.Virtualized.scrollXBy. Scroll the content horizontally by the given amount. Annotations @Override

scrollXBy

back to summary

public void scrollXBy(double deltaX)

Implements org.fxmisc.flowless.Virtualized.scrollXBy.

Doc from org.fxmisc.flowless.Virtualized.scrollXBy.

Scroll the content horizontally by the given amount.

Annotations

@Override

scrollXToPixel	back to summary
public void scrollXToPixel(double pixel) Implements org.fxmisc.flowless.Virtualized.scrollXToPixel. Doc from org.fxmisc.flowless.Virtualized.scrollXToPixel. Scroll the content horizontally to the pixel Annotations @Override

scrollXToPixel

back to summary

public void scrollXToPixel(double pixel)

Implements org.fxmisc.flowless.Virtualized.scrollXToPixel.

Doc from org.fxmisc.flowless.Virtualized.scrollXToPixel.

Scroll the content horizontally to the pixel

Annotations

@Override

scrollYBy	back to summary
public void scrollYBy(double deltaY) Implements org.fxmisc.flowless.Virtualized.scrollYBy. Doc from org.fxmisc.flowless.Virtualized.scrollYBy. Scroll the content vertically by the given amount. Annotations @Override

scrollYBy

back to summary

public void scrollYBy(double deltaY)

Implements org.fxmisc.flowless.Virtualized.scrollYBy.

Doc from org.fxmisc.flowless.Virtualized.scrollYBy.

Scroll the content vertically by the given amount.

Annotations

@Override

scrollYToPixel	back to summary
public void scrollYToPixel(double pixel) Implements org.fxmisc.flowless.Virtualized.scrollYToPixel. Doc from org.fxmisc.flowless.Virtualized.scrollYToPixel. Scroll the content vertically to the pixel Annotations @Override

scrollYToPixel

back to summary

public void scrollYToPixel(double pixel)

Implements org.fxmisc.flowless.Virtualized.scrollYToPixel.

Doc from org.fxmisc.flowless.Virtualized.scrollYToPixel.

Scroll the content vertically to the pixel

Annotations

@Override

setHbarPolicy	back to summary
public final void setHbarPolicy(ScrollPane.ScrollBarPolicy value)

setHPosition	back to summary
private void setHPosition(double pos)

setupUnitIncrement	back to summary
private static void setupUnitIncrement(ScrollBar bar)

setVbarPolicy	back to summary
public final void setVbarPolicy(ScrollPane.ScrollBarPolicy value)

setVPosition	back to summary
private void setVPosition(double pos)

totalHeightEstimateProperty	back to summary
public Val<Double> totalHeightEstimateProperty() Implements org.fxmisc.flowless.Virtualized.totalHeightEstimateProperty. Annotations @Override

totalHeightEstimateProperty

back to summary

public Val<Double> totalHeightEstimateProperty()

Implements org.fxmisc.flowless.Virtualized.totalHeightEstimateProperty.

Annotations

@Override

totalWidthEstimateProperty	back to summary
public Val<Double> totalWidthEstimateProperty() Implements org.fxmisc.flowless.Virtualized.totalWidthEstimateProperty. Annotations @Override

totalWidthEstimateProperty

back to summary

public Val<Double> totalWidthEstimateProperty()

Implements org.fxmisc.flowless.Virtualized.totalWidthEstimateProperty.

Annotations

@Override

unbindScrollBar	back to summary
private void unbindScrollBar(ScrollBar bar)

vbarPolicyProperty	back to summary
public final Var<ScrollPane.ScrollBarPolicy> vbarPolicyProperty()

public Class VirtualizedScrollPane<V extends Region & Virtualized>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail