Index
All Classes and Interfaces|All Packages|Serialized Form
A
- AbstractHelper(VFXList<T, C>) - Constructor for class io.github.palexdev.virtualizedfx.list.VFXListHelper.AbstractHelper
- add(C) - Method in class io.github.palexdev.virtualizedfx.utils.CellsQueue
- addAll(Collection<? extends C>) - Method in class io.github.palexdev.virtualizedfx.utils.CellsQueue
- addCell(int, C) - Method in class io.github.palexdev.virtualizedfx.list.VFXListState
-
Retrieves the item at the given index from
VFXList.itemsProperty()
and delegates toVFXListState.addCell(int, Object, Cell)
. - addCell(int, T, C) - Method in class io.github.palexdev.virtualizedfx.list.VFXListState
-
Adds the given cell to the
StateMap
of this state object. - addListeners() - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListSkin
-
Adds listeners on the component's properties which need to produce a new
VFXListState
upon changing. - addListeners() - Method in class io.github.palexdev.virtualizedfx.list.VFXListSkin
-
Adds listeners on the component's properties which need to produce a new
VFXListState
upon changing.
B
- BIG - Enum constant in enum class io.github.palexdev.virtualizedfx.enums.BufferSize
- BufferSize - Enum Class in io.github.palexdev.virtualizedfx.enums
-
Enumeration to set the buffer size of Virtualized containers.
- bufferSizeProperty() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Specifies the number of extra cells to add to the container; they act as a buffer, allowing scroll to be smoother.
- buildSkin() - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedList
- buildSkin() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
C
- cache(C...) - Method in class io.github.palexdev.virtualizedfx.list.VFXListCache
-
Adds the given cells to the queue.
- cache(Collection<C>) - Method in class io.github.palexdev.virtualizedfx.list.VFXListCache
-
Adds the given cells to the queue.
- cacheCapacityProperty() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Specifies the maximum number of cells the cache can contain at any time.
- Cell<T> - Interface in io.github.palexdev.virtualizedfx.cells
-
Public, base API for all cells used by any virtualized container.
- CellBase<T> - Class in io.github.palexdev.virtualizedfx.cells
-
The basic and typical implementation of a cell in JavaFX is a cell with just two properties: one to keep track of the cell's index and the other to keep track of the displayed item.
- CellBase() - Constructor for class io.github.palexdev.virtualizedfx.cells.CellBase
- CellBase(T) - Constructor for class io.github.palexdev.virtualizedfx.cells.CellBase
- CellBaseBehavior<T> - Class in io.github.palexdev.virtualizedfx.cells
-
Base, empty behavior for cells of type
CellBase
, extendsBehaviorBase
. - CellBaseBehavior(CellBase<T>) - Constructor for class io.github.palexdev.virtualizedfx.cells.CellBaseBehavior
- cellFactoryProperty() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Specifies the function used to build the cells.
- cellSizeProperty() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Specifies the cells' size:
- cellsPerPageProperty() - Method in interface io.github.palexdev.virtualizedfx.base.Paginated
-
Specifies the number of cells/items to show per each page.
- cellsPerPageProperty() - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedList
-
Specifies the number of cells/items to show per each page.
- CellsQueue<T,
C> - Class in io.github.palexdev.virtualizedfx.utils -
A special kind of
LinkedList
which discards the oldest added item once it reaches the set capacity. - CellsQueue(int) - Constructor for class io.github.palexdev.virtualizedfx.utils.CellsQueue
- clear() - Method in class io.github.palexdev.virtualizedfx.list.VFXListCache
-
Disposes and removes all the cells from the cache.
- clear() - Method in class io.github.palexdev.virtualizedfx.utils.StateMap
-
Clears both the used maps.
- clip - Variable in class io.github.palexdev.virtualizedfx.list.VFXListSkin
- clipBorderRadiusProperty() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Used by the viewport's clip to set its border radius.
- computeBreadth(Node) - Method in interface io.github.palexdev.virtualizedfx.list.VFXListHelper
-
Computes the breadth of the given node.
- computeBreadth(Node) - Method in class io.github.palexdev.virtualizedfx.list.VFXListHelper.HorizontalHelper
-
Computes the breadth of the given node.
- computeBreadth(Node) - Method in class io.github.palexdev.virtualizedfx.list.VFXListHelper.VerticalHelper
-
Computes the breadth of the given node.
- computeMaxHeight(double, double, double, double, double) - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListSkin
- computeMaxPage() - Method in interface io.github.palexdev.virtualizedfx.base.Paginated
-
Computes the maximum page index reachable by the container.
- computeMaxWidth(double, double, double, double, double) - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListSkin
- computeMinHeight(double, double, double, double, double) - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListSkin
- computeMinHeight(double, double, double, double, double) - Method in class io.github.palexdev.virtualizedfx.list.VFXListSkin
- computeMinWidth(double, double, double, double, double) - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListSkin
- computeMinWidth(double, double, double, double, double) - Method in class io.github.palexdev.virtualizedfx.list.VFXListSkin
- computePrefHeight(double, double, double, double, double) - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListSkin
- computePrefWidth(double, double, double, double, double) - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListSkin
- contains(Integer) - Method in class io.github.palexdev.virtualizedfx.utils.StateMap
-
Checks if the map [Index -> Cell] contains the given index.
- contains(T) - Method in class io.github.palexdev.virtualizedfx.utils.StateMap
-
Checks if the map [Item -> Index] contains the given item.
- createCache() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Responsible for creating the cache instance used by this container.
D
- DEFAULT_SIZE - Variable in class io.github.palexdev.virtualizedfx.list.VFXListSkin
- defaultBehaviorProvider() - Method in class io.github.palexdev.virtualizedfx.cells.CellBase
- defaultBehaviorProvider() - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedList
- defaultBehaviorProvider() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
- defaultHelperFactory() - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedList
- defaultHelperFactory() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
- dispose() - Method in interface io.github.palexdev.virtualizedfx.cells.Cell
-
Automatically called by the framework when the cell is not needed anymore.
- dispose() - Method in interface io.github.palexdev.virtualizedfx.list.VFXListHelper
-
Automatically called by
VFXList
when a helper is not needed anymore (changed). - dispose() - Method in class io.github.palexdev.virtualizedfx.list.VFXListSkin
- dispose() - Method in class io.github.palexdev.virtualizedfx.list.VFXListState
-
Disposes this state object by: caching all the cells (
VFXListCache.cache(Collection)
), and then clearing theStateMap
(StateMap.clear()
). - disposeCurrent() - Method in class io.github.palexdev.virtualizedfx.list.VFXListManager
-
Avoids code duplication.
E
- EMPTY - Static variable in class io.github.palexdev.virtualizedfx.list.VFXListState
-
Special instance of
VFXListState
used to indicate that no cells can be present in the viewport at a certain time. - emptyProperty() - Method in interface io.github.palexdev.virtualizedfx.base.VFXContainer
-
Specifies whether the data set is empty.
- emptyProperty() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Delegate for
ListExpression.emptyProperty()
- estimatedLength - Variable in class io.github.palexdev.virtualizedfx.list.VFXListHelper.AbstractHelper
- estimatedLengthProperty() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Delegate for
VFXListHelper.estimatedLengthProperty()
. - estimatedLengthProperty() - Method in class io.github.palexdev.virtualizedfx.list.VFXListHelper.AbstractHelper
- estimatedLengthProperty() - Method in interface io.github.palexdev.virtualizedfx.list.VFXListHelper
-
Specifies the virtual length of the viewport (total width/height).
F
- findPageByIndex(int) - Method in interface io.github.palexdev.virtualizedfx.base.Paginated
-
Given an index, returns the page at which it would be displayed by the container.
- firstVisible() - Method in interface io.github.palexdev.virtualizedfx.list.VFXListHelper
- firstVisible() - Method in class io.github.palexdev.virtualizedfx.list.VFXListHelper.HorizontalHelper
- firstVisible() - Method in class io.github.palexdev.virtualizedfx.list.VFXListHelper.VerticalHelper
- fitToBreadthProperty() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Specifies whether cells should be resized to be the same size of the viewport in the opposite direction of the current
VFXList.orientationProperty()
.
G
- getBehavior() - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListSkin
-
Overridden to cast the behavior to
VFXPaginatedListManager
. - getBufferSize() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Gets the value of the
bufferSize
property. - getByIndex() - Method in class io.github.palexdev.virtualizedfx.utils.StateMap
- getByItem() - Method in class io.github.palexdev.virtualizedfx.utils.StateMap
- getCache() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
- getCacheCapacity() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Gets the value of the
cacheCapacity
property. - getCapacity() - Method in class io.github.palexdev.virtualizedfx.utils.CellsQueue
- getCell(Integer) - Method in class io.github.palexdev.virtualizedfx.utils.StateMap
-
Tries retrieving a cell by the given index.
- getCell(T) - Method in class io.github.palexdev.virtualizedfx.utils.StateMap
-
Tries retrieving a cell by the given item.
- getCellFactory() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Gets the value of the
cellFactory
property. - getCells() - Method in class io.github.palexdev.virtualizedfx.list.VFXListState
- getCellsByIndex() - Method in class io.github.palexdev.virtualizedfx.list.VFXListState
- getCellsByIndexUnmodifiable() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Delegate for
VFXListState.getCellsByIndexUnmodifiable()
- getCellsByIndexUnmodifiable() - Method in class io.github.palexdev.virtualizedfx.list.VFXListState
- getCellsByItem() - Method in class io.github.palexdev.virtualizedfx.list.VFXListState
- getCellsByItemUnmodifiable() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Delegate for
VFXListState.getCellsByItemUnmodifiable()
- getCellsByItemUnmodifiable() - Method in class io.github.palexdev.virtualizedfx.list.VFXListState
- getCellSize() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Gets the value of the
cellSize
property. - getCellsPerPage() - Method in interface io.github.palexdev.virtualizedfx.base.Paginated
-
Gets the value of the
cellsPerPage
property. - getCellsPerPage() - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedList
-
Gets the value of the
cellsPerPage
property. - getClassCssMetaData() - Static method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedList
- getClassCssMetaData() - Static method in class io.github.palexdev.virtualizedfx.list.VFXList
- getClipBorderRadius() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Gets the value of the
clipBorderRadius
property. - getControlCssMetaData() - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedList
- getControlCssMetaData() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
- getHelper() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Gets the value of the
helper
property. - getHelperFactory() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Gets the value of the
helperFactory
property. - getHPos() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Gets the value of the
hPos
property. - getIndex() - Method in class io.github.palexdev.virtualizedfx.cells.CellBase
-
Gets the value of the
index
property. - getItem() - Method in class io.github.palexdev.virtualizedfx.cells.CellBase
-
Gets the value of the
item
property. - getItems() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Gets the value of the
items
property. - getLength() - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListSkin
-
Computes the length the container should have, according to the following three properties:
- getList() - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListHelper.HorizontalHelper
- getList() - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListHelper.VerticalHelper
- getList() - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListSkin
-
Convenience method to cast
SkinBase.getSkinnable()
toVFXPaginatedList
. - getList() - Method in class io.github.palexdev.virtualizedfx.list.VFXListHelper.AbstractHelper
- getList() - Method in interface io.github.palexdev.virtualizedfx.list.VFXListHelper
- getList() - Method in class io.github.palexdev.virtualizedfx.list.VFXListState
- getMaxPage() - Method in interface io.github.palexdev.virtualizedfx.base.Paginated
-
Gets the value of the
maxPage
property. - getMaxPage() - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedList
-
Gets the value of the
maxPage
property. - getNode() - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListManager
-
Overridden to cast to
VFXPaginatedList
since this behavior only allows that type. - getNodes() - Method in class io.github.palexdev.virtualizedfx.list.VFXListState
- getOrientation() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Gets the value of the
orientation
property. - getPage() - Method in interface io.github.palexdev.virtualizedfx.base.Paginated
-
Gets the value of the
page
property. - getPage() - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedList
-
Gets the value of the
page
property. - getRange() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Delegate for
VFXListState.getRange()
- getRange() - Method in class io.github.palexdev.virtualizedfx.list.VFXListState
- getResource(String) - Static method in class io.github.palexdev.virtualizedfx.Resources
- getSpacing() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Gets the value of the
spacing
property. - getState() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Gets the value of the
state
property. - getTotalCellSize() - Method in interface io.github.palexdev.virtualizedfx.list.VFXListHelper
-
Implementing the
VFXList.spacingProperty()
has been incredibly easy. - getVisibleCellsByIndex() - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedList
-
By using the
IntegerRange
computed byVFXPaginatedList.getVisibleRange()
, filters theStateMap
(from the current stateVFXList.stateProperty()
), and returns a map of the visible cells by their index. - getVisibleCellsByItem() - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedList
-
By using the
IntegerRange
computed byVFXPaginatedList.getVisibleRange()
, filters theStateMap
(from the current stateVFXList.stateProperty()
), and returns a map of the visible cells by the displayed item. - getVisibleRange() - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedList
-
Computes the range of visible items for the current page.
- getVPos() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Gets the value of the
vPos
property.
H
- haveCellsChanged() - Method in class io.github.palexdev.virtualizedfx.list.VFXListState
- helperFactoryProperty() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Specifies the function used to build a
VFXListHelper
instance depending on the container's orientation. - helperProperty() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Specifies the instance of the
VFXListHelper
built by theVFXList.helperFactoryProperty()
. - HorizontalHelper(VFXPaginatedList<T, C>) - Constructor for class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListHelper.HorizontalHelper
- HorizontalHelper(VFXList<T, C>) - Constructor for class io.github.palexdev.virtualizedfx.list.VFXListHelper.HorizontalHelper
- hPosProperty() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Specifies the container's horizontal position.
I
- indexProperty() - Method in class io.github.palexdev.virtualizedfx.cells.CellBase
-
Specifies the cell's index.
- indexToCell(int) - Method in interface io.github.palexdev.virtualizedfx.list.VFXListHelper
-
Converts the given index to a cell.
- indexToItem(int) - Method in interface io.github.palexdev.virtualizedfx.list.VFXListHelper
-
Converts the given index to an item (shortcut for
getList().getItems().get(index)
). - initBehavior(VFXListManager<T, C>) - Method in class io.github.palexdev.virtualizedfx.list.VFXListSkin
- initialize() - Method in class io.github.palexdev.virtualizedfx.cells.CellBase
- intersection(IntegerRange, IntegerRange) - Static method in class io.github.palexdev.virtualizedfx.utils.Utils
-
Finds the
IntegerRange
which is the intersection between the two given ranges. - intersectionAlgorithm() - Method in class io.github.palexdev.virtualizedfx.list.VFXListManager
-
Avoids code duplication.
- INVALID_RANGE - Static variable in class io.github.palexdev.virtualizedfx.utils.Utils
-
Special instance of
IntegerRange
with bothmin
andmax
set to -1. - invalidatePos() - Method in interface io.github.palexdev.virtualizedfx.list.VFXListHelper
-
Forces the
VFXList.vPosProperty()
andVFXList.hPosProperty()
to be invalidated. - invalidatingPos - Variable in class io.github.palexdev.virtualizedfx.list.VFXListManager
- io.github.palexdev.virtualizedfx - package io.github.palexdev.virtualizedfx
- io.github.palexdev.virtualizedfx.base - package io.github.palexdev.virtualizedfx.base
- io.github.palexdev.virtualizedfx.cells - package io.github.palexdev.virtualizedfx.cells
- io.github.palexdev.virtualizedfx.enums - package io.github.palexdev.virtualizedfx.enums
- io.github.palexdev.virtualizedfx.list - package io.github.palexdev.virtualizedfx.list
- io.github.palexdev.virtualizedfx.list.paginated - package io.github.palexdev.virtualizedfx.list.paginated
- io.github.palexdev.virtualizedfx.properties - package io.github.palexdev.virtualizedfx.properties
- io.github.palexdev.virtualizedfx.utils - package io.github.palexdev.virtualizedfx.utils
- isEmpty() - Method in interface io.github.palexdev.virtualizedfx.base.VFXContainer
-
Gets the value of the
empty
property. - isEmpty() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Delegate for
ListExpression.isEmpty()
. - isEmpty() - Method in class io.github.palexdev.virtualizedfx.list.VFXListState
- isEmpty() - Method in class io.github.palexdev.virtualizedfx.utils.StateMap
- isFitToBreadth() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Gets the value of the
fitToBreadth
property. - isNeedsViewportLayout() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Gets the value of the
needsViewportLayout
property. - itemProperty() - Method in class io.github.palexdev.virtualizedfx.cells.CellBase
-
Specifies the cell's item.
- itemsProperty() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Specifies the
ObservableList
used to store the items. - itemToCell(T) - Method in interface io.github.palexdev.virtualizedfx.list.VFXListHelper
-
Converts the given item to a cell.
L
- lastVisible() - Method in class io.github.palexdev.virtualizedfx.list.VFXListHelper.HorizontalHelper
- lastVisible() - Method in interface io.github.palexdev.virtualizedfx.list.VFXListHelper
- lastVisible() - Method in class io.github.palexdev.virtualizedfx.list.VFXListHelper.VerticalHelper
- layout() - Method in class io.github.palexdev.virtualizedfx.list.VFXListSkin
-
Core method responsible for resizing and positioning cells in the viewport.
- layout(int, Node) - Method in class io.github.palexdev.virtualizedfx.list.VFXListHelper.HorizontalHelper
-
Lays out the given node.
- layout(int, Node) - Method in interface io.github.palexdev.virtualizedfx.list.VFXListHelper
-
Lays out the given node.
- layout(int, Node) - Method in class io.github.palexdev.virtualizedfx.list.VFXListHelper.VerticalHelper
-
Lays out the given node.
- list - Variable in class io.github.palexdev.virtualizedfx.list.VFXListHelper.AbstractHelper
- listFactorySizeCheck() - Method in class io.github.palexdev.virtualizedfx.list.VFXListManager
-
Avoids code duplication.
- loadResource(String) - Static method in class io.github.palexdev.virtualizedfx.Resources
M
- maxBreadth - Variable in class io.github.palexdev.virtualizedfx.list.VFXListHelper.AbstractHelper
- maxBreadthProperty() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Delegate for
VFXListHelper.maxBreadthProperty()
. - maxBreadthProperty() - Method in class io.github.palexdev.virtualizedfx.list.VFXListHelper.AbstractHelper
- maxBreadthProperty() - Method in interface io.github.palexdev.virtualizedfx.list.VFXListHelper
-
Specifies the maximum breadth, opposed to the container's orientation.
- maxHScroll() - Method in class io.github.palexdev.virtualizedfx.list.VFXListHelper.HorizontalHelper
- maxHScroll() - Method in interface io.github.palexdev.virtualizedfx.list.VFXListHelper
- maxHScroll() - Method in class io.github.palexdev.virtualizedfx.list.VFXListHelper.VerticalHelper
- maxPageProperty() - Method in interface io.github.palexdev.virtualizedfx.base.Paginated
-
Specifies the maximum page index at which the container can go.
- maxPageProperty() - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedList
- maxVScroll() - Method in class io.github.palexdev.virtualizedfx.list.VFXListHelper.HorizontalHelper
- maxVScroll() - Method in interface io.github.palexdev.virtualizedfx.list.VFXListHelper
- maxVScroll() - Method in class io.github.palexdev.virtualizedfx.list.VFXListHelper.VerticalHelper
- MEDIUM - Enum constant in enum class io.github.palexdev.virtualizedfx.enums.BufferSize
- moveBy(int) - Method in interface io.github.palexdev.virtualizedfx.base.Paginated
-
Changes the page by the given delta.
- moveReuseCreateAlgorithm(IntegerRange, VFXListState<T, C>) - Method in class io.github.palexdev.virtualizedfx.list.VFXListManager
-
Avoids code duplication.
N
- needsViewportLayoutProperty() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Specifies whether the viewport needs to compute the layout of its content.
- next() - Method in interface io.github.palexdev.virtualizedfx.base.Paginated
-
Goes to the next page if possible.
O
- onCache() - Method in interface io.github.palexdev.virtualizedfx.cells.Cell
-
Virtualized containers that make use of a cache to store unneeded cells that may be required again in a second time should call this when adding the cell to the cache.
- onCellFactoryChanged() - Method in class io.github.palexdev.virtualizedfx.list.VFXListManager
-
This method is responsible for updating the list's state when the
VFXList.cellFactoryProperty()
changes. - onCellSizeChanged() - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListManager
-
Overridden to just call
VFXList.requestViewportLayout()
. - onCellSizeChanged() - Method in class io.github.palexdev.virtualizedfx.list.VFXListManager
-
This method is responsible for computing a new state when the
VFXList.cellSizeProperty()
changes. - onCellsPerPageChanged() - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListManager
-
A paginated container's size strictly depends on how many cells/rows/items is set to display per page, and this is enforced by the default skin
VFXPaginatedListSkin
, seegetLength()
. - onDeCache() - Method in interface io.github.palexdev.virtualizedfx.cells.Cell
-
Virtualized containers that make use of a cache to store unneeded cells that may be required again in a second time should call this when removing the cell from the cache.
- onFitToBreadthChanged() - Method in class io.github.palexdev.virtualizedfx.list.VFXListManager
-
The easiest of all changes.
- onGeometryChanged() - Method in class io.github.palexdev.virtualizedfx.list.VFXListManager
-
This core method is responsible for ensuring that the viewport always has the right number of cells.
- onItemsChanged() - Method in class io.github.palexdev.virtualizedfx.list.VFXListManager
-
Before describing the operations performed by this method, it's important for the reader to understand the difference between the two changes caught by this method.
- onLayoutCompleted(boolean) - Method in class io.github.palexdev.virtualizedfx.list.VFXListSkin
-
This method is crucial because it resets the
VFXList.needsViewportLayoutProperty()
to false. - onMaxPageChanged() - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListManager
-
This core method ensures that the paginated container is always at a valid page/position when the
VFXPaginatedList.maxPageProperty()
changes. - onOrientationChanged() - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListManager
-
As also described in the super method (
VFXListManager.onOrientationChanged()
), when the orientation changes the most reasonable behavior is to reset both the positions to 0.0. - onOrientationChanged() - Method in class io.github.palexdev.virtualizedfx.list.VFXListManager
-
This method is responsible for computing a new state when the
VFXList.orientationProperty()
changes. - onPositionChanged() - Method in class io.github.palexdev.virtualizedfx.list.VFXListManager
-
This core method is responsible for updating the list's state when the 'main' position changes (vPos for VERTICAL orientation, hPos for HORIZONTAL orientation).
- onSpacingChanged() - Method in class io.github.palexdev.virtualizedfx.list.VFXListManager
-
This method is responsible for updating the list's state when the
VFXList.spacingProperty()
changes. - orientationProperty() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Specifies the orientation of the virtual flow.
P
- pageProperty() - Method in interface io.github.palexdev.virtualizedfx.base.Paginated
-
Specifies the page at which the container is.
- pageProperty() - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedList
- Paginated - Interface in io.github.palexdev.virtualizedfx.base
-
Defines the common API for every paginated virtualized container offered by VirtualizedFX.
- pl - Variable in class io.github.palexdev.virtualizedfx.list.VFXListSkin
- poll() - Method in class io.github.palexdev.virtualizedfx.utils.StateMap
-
Removes the first entry from the map [Integer -> Cell] by using
SequencedMap.pollFirstEntry()
. - populate() - Method in class io.github.palexdev.virtualizedfx.list.VFXListCache
-
Fills the cache to its limit.
- posBinding - Variable in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListSkin
- previous() - Method in interface io.github.palexdev.virtualizedfx.base.Paginated
-
Goes to the previous page if possible.
- put(Integer, T, C) - Method in class io.github.palexdev.virtualizedfx.utils.StateMap
-
Adds a cell to both the maps used by this data structure.
Q
- queue(C) - Method in class io.github.palexdev.virtualizedfx.utils.CellsQueue
-
Adds the given cell to the queue.
R
- range - Variable in class io.github.palexdev.virtualizedfx.list.VFXListHelper.AbstractHelper
- range() - Method in class io.github.palexdev.virtualizedfx.list.VFXListHelper.AbstractHelper
- range() - Method in interface io.github.palexdev.virtualizedfx.list.VFXListHelper
- rangeCheck(IntegerRange, boolean, boolean) - Method in class io.github.palexdev.virtualizedfx.list.VFXListManager
-
Avoids code duplication.
- remainingAlgorithm(Set<Integer>, VFXListState<T, C>) - Method in class io.github.palexdev.virtualizedfx.list.VFXListManager
-
Avoids code duplication.
- remove(C) - Method in class io.github.palexdev.virtualizedfx.list.VFXListCache
-
Removed the specified cell from the cache's queue.
- remove(Integer) - Method in class io.github.palexdev.virtualizedfx.utils.StateMap
-
Removes a cell from the map [Integer -> Cell] by the given index.
- remove(T) - Method in class io.github.palexdev.virtualizedfx.utils.StateMap
-
Removes an index from the map [Item -> Index] and then if the index is not null, removes a cell from the map [Integer -> Cell] by the found index.
- removeCell(int) - Method in class io.github.palexdev.virtualizedfx.list.VFXListState
-
Removes a cell from the
StateMap
for the given index. - removeCell(T) - Method in class io.github.palexdev.virtualizedfx.list.VFXListState
-
Removes a cell from the
StateMap
for the given item. - requestViewportLayout() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Setter for the
VFXList.needsViewportLayoutProperty()
. - resolve() - Method in class io.github.palexdev.virtualizedfx.utils.StateMap
-
Resolves the double correspondence [Integer -> Cell invalid input: '<'- Item] returning a map that directly gives [Item -> Cell].
- Resources - Class in io.github.palexdev.virtualizedfx
S
- scrollBy(double) - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListHelper.HorizontalHelper
- scrollBy(double) - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListHelper.VerticalHelper
- scrollBy(double) - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Delegate for
VFXListHelper.scrollBy(double)
. - scrollBy(double) - Method in class io.github.palexdev.virtualizedfx.list.VFXListHelper.HorizontalHelper
- scrollBy(double) - Method in interface io.github.palexdev.virtualizedfx.list.VFXListHelper
-
Scrolls in the viewport by the given number of pixels.
- scrollBy(double) - Method in class io.github.palexdev.virtualizedfx.list.VFXListHelper.VerticalHelper
- scrollToFirst() - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedList
-
Shortcut for
setPage(0)
. - scrollToFirst() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Shortcut for
scrollToIndex(0)
. - scrollToIndex(int) - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListHelper.HorizontalHelper
-
Scrolls to the page containing the given item index.
- scrollToIndex(int) - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListHelper.VerticalHelper
-
Scrolls to the page containing the given item index.
- scrollToIndex(int) - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Delegate for
VFXListHelper.scrollToIndex(int)
. - scrollToIndex(int) - Method in class io.github.palexdev.virtualizedfx.list.VFXListHelper.HorizontalHelper
- scrollToIndex(int) - Method in interface io.github.palexdev.virtualizedfx.list.VFXListHelper
-
Scrolls in the viewport to the given item's index.
- scrollToIndex(int) - Method in class io.github.palexdev.virtualizedfx.list.VFXListHelper.VerticalHelper
- scrollToLast() - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedList
-
Shortcut for
setPage(getMaxPage())
. - scrollToLast() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Shortcut for
scrollToIndex(size() - 1)
. - scrollToPixel(double) - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListHelper.HorizontalHelper
- scrollToPixel(double) - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListHelper.VerticalHelper
- scrollToPixel(double) - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Delegate for
VFXListHelper.scrollToPixel(double)
. - scrollToPixel(double) - Method in class io.github.palexdev.virtualizedfx.list.VFXListHelper.HorizontalHelper
- scrollToPixel(double) - Method in interface io.github.palexdev.virtualizedfx.list.VFXListHelper
-
Scrolls in the viewport to the given pixel value.
- scrollToPixel(double) - Method in class io.github.palexdev.virtualizedfx.list.VFXListHelper.VerticalHelper
- setBufferSize(BufferSize) - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Sets the value of the
bufferSize
property. - setCacheCapacity(int) - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Sets the value of the
cacheCapacity
property. - setCapacity(int) - Method in class io.github.palexdev.virtualizedfx.list.VFXListCache
-
Sets the cache's capacity.
- setCapacity(int) - Method in class io.github.palexdev.virtualizedfx.utils.CellsQueue
-
Sets the queue's capacity.
- setCellFactory(Function<T, C>) - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Sets the value of the
cellFactory
property. - setCellsChanged(boolean) - Method in class io.github.palexdev.virtualizedfx.list.VFXListState
- setCellSize(double) - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Sets the value of the
cellSize
property. - setCellsPerPage(int) - Method in interface io.github.palexdev.virtualizedfx.base.Paginated
-
Sets the value of the
cellsPerPage
property. - setCellsPerPage(int) - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedList
-
Sets the value of the
cellsPerPage
property. - setClipBorderRadius(double) - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Sets the value of the
clipBorderRadius
property. - setFitToBreadth(boolean) - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Sets the value of the
fitToBreadth
property. - setHelper(VFXListHelper<T, C>) - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Sets the value of the
helper
property. - setHelperFactory(Function<Orientation, VFXListHelper<T, C>>) - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Sets the value of the
helperFactory
property. - setHPos(double) - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedList
-
Since for the paginated variant the position is bound to the
VFXPaginatedList.pageProperty()
, this setter won't do anything if the current orientation is horizontal. - setHPos(double) - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Sets the value of the
hPos
property. - setIndex(int) - Method in class io.github.palexdev.virtualizedfx.cells.CellBase
-
Sets the value of the
index
property. - setItem(T) - Method in class io.github.palexdev.virtualizedfx.cells.CellBase
-
Sets the value of the
item
property. - setItems(ObservableList<T>) - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Sets the value of the
items
property. - setNeedsViewportLayout(boolean) - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Sets the value of the
needsViewportLayout
property. - setOrientation(Orientation) - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Sets the value of the
orientation
property. - setPage(int) - Method in interface io.github.palexdev.virtualizedfx.base.Paginated
-
Sets the value of the
page
property. - setPage(int) - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedList
-
Sets the value of the
page
property. - setSpacing(double) - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Sets the value of the
spacing
property. - setState(VFXListState<T, C>) - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Sets the value of the
state
property. - setVPos(double) - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedList
-
Since for the paginated variant the position is bound to the
VFXPaginatedList.pageProperty()
, this setter won't do anything if the current orientation is vertical. - setVPos(double) - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Sets the value of the
vPos
property. - size() - Method in interface io.github.palexdev.virtualizedfx.base.VFXContainer
- size() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Delegate for
ListExpression.size()
. - size() - Method in class io.github.palexdev.virtualizedfx.list.VFXListCache
- size() - Method in class io.github.palexdev.virtualizedfx.utils.StateMap
- sizeProperty() - Method in interface io.github.palexdev.virtualizedfx.base.VFXContainer
-
Specifies the number of items in the data structure.
- sizeProperty() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Delegate for
ListExpression.sizeProperty()
. - SMALL - Enum constant in enum class io.github.palexdev.virtualizedfx.enums.BufferSize
- spacingProperty() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Specifies the number of pixels between each cell.
- standard() - Static method in enum class io.github.palexdev.virtualizedfx.enums.BufferSize
- StateMap<T,
C> - Class in io.github.palexdev.virtualizedfx.utils -
A wrapper class for two
Map
collections, used to store the cells of a virtualized container's state. - StateMap() - Constructor for class io.github.palexdev.virtualizedfx.utils.StateMap
- stateProperty() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Specifies the container's current state.
- swapPositionBinding() - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListSkin
-
Responsible for swapping the position's binding when the orientation changes.
- swapPositionListener() - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListSkin
-
You can scroll along two directions: vertically and horizontally.
- swapPositionListener() - Method in class io.github.palexdev.virtualizedfx.list.VFXListSkin
-
You can scroll along two directions: vertically and horizontally.
T
- take() - Method in class io.github.palexdev.virtualizedfx.list.VFXListCache
-
Removes one cell from the cache, specifically from the queue's head, so the oldest cached cell.
- toNode() - Method in interface io.github.palexdev.virtualizedfx.cells.Cell
-
Converts the cell to a
Node
. - toNode() - Method in class io.github.palexdev.virtualizedfx.cells.CellBase
- totalNum() - Method in class io.github.palexdev.virtualizedfx.list.VFXListHelper.AbstractHelper
- totalNum() - Method in interface io.github.palexdev.virtualizedfx.list.VFXListHelper
- tryTake() - Method in class io.github.palexdev.virtualizedfx.list.VFXListCache
-
Wraps the result of
VFXListCache.take()
in anOptional
instance.
U
- update(VFXListState<T, C>) - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Setter for the
VFXList.stateProperty()
. - updateIndex(int) - Method in interface io.github.palexdev.virtualizedfx.cells.Cell
-
Automatically called by the framework when the cell needs to update its index.
- updateIndex(int) - Method in class io.github.palexdev.virtualizedfx.cells.CellBase
-
Automatically called by the framework when the cell needs to update its index.
- updateItem(T) - Method in interface io.github.palexdev.virtualizedfx.cells.Cell
-
Automatically called by the framework when the cell needs to update its item.
- updateItem(T) - Method in class io.github.palexdev.virtualizedfx.cells.CellBase
-
Automatically called by the framework when the cell needs to update its item.
- Utils - Class in io.github.palexdev.virtualizedfx.utils
V
- val() - Method in enum class io.github.palexdev.virtualizedfx.enums.BufferSize
- valueOf(String) - Static method in enum class io.github.palexdev.virtualizedfx.enums.BufferSize
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class io.github.palexdev.virtualizedfx.enums.BufferSize
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VerticalHelper(VFXPaginatedList<T, C>) - Constructor for class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListHelper.VerticalHelper
- VerticalHelper(VFXList<T, C>) - Constructor for class io.github.palexdev.virtualizedfx.list.VFXListHelper.VerticalHelper
- VFXContainer - Interface in io.github.palexdev.virtualizedfx.base
-
Defines the common API for every virtualized container offered by VirtualizedFX.
- VFXList<T,
C> - Class in io.github.palexdev.virtualizedfx.list -
Implementation of a virtualized container to show a list of items either vertically or horizontally.
- VFXList() - Constructor for class io.github.palexdev.virtualizedfx.list.VFXList
- VFXList(ObservableList<T>, Function<T, C>) - Constructor for class io.github.palexdev.virtualizedfx.list.VFXList
- VFXList(ObservableList<T>, Function<T, C>, Orientation) - Constructor for class io.github.palexdev.virtualizedfx.list.VFXList
- VFXListCache<T,
C> - Class in io.github.palexdev.virtualizedfx.list -
Simple cache implementation for the
VFXList
container. - VFXListCache(VFXList<T, C>) - Constructor for class io.github.palexdev.virtualizedfx.list.VFXListCache
- VFXListCache(VFXList<T, C>, int) - Constructor for class io.github.palexdev.virtualizedfx.list.VFXListCache
- VFXListHelper<T,
C> - Interface in io.github.palexdev.virtualizedfx.list -
This interface is a utility API for
VFXList
which helps to avoid if checks that depend on the container's orientation,VFXList.orientationProperty()
. - VFXListHelper.AbstractHelper<T,
C> - Class in io.github.palexdev.virtualizedfx.list -
Abstract implementation of
VFXListHelper
, contains common members for the two concrete implementationsVFXListHelper.VerticalHelper
andVFXListHelper.HorizontalHelper
, such as: - VFXListHelper.HorizontalHelper<T,
C> - Class in io.github.palexdev.virtualizedfx.list -
Concrete implementation of
VFXListHelper.AbstractHelper
forOrientation.HORIZONTAL
. - VFXListHelper.VerticalHelper<T,
C> - Class in io.github.palexdev.virtualizedfx.list -
Concrete implementation of
VFXListHelper.AbstractHelper
forOrientation.VERTICAL
. - VFXListManager<T,
C> - Class in io.github.palexdev.virtualizedfx.list -
Default behavior implementation for
VFXList
. - VFXListManager(VFXList<T, C>) - Constructor for class io.github.palexdev.virtualizedfx.list.VFXListManager
- VFXListSkin<T,
C> - Class in io.github.palexdev.virtualizedfx.list -
Default skin implementation for
VFXList
, extendsSkinBase
and expects behaviors of typeVFXListManager
. - VFXListSkin(VFXList<T, C>) - Constructor for class io.github.palexdev.virtualizedfx.list.VFXListSkin
- VFXListState<T,
C> - Class in io.github.palexdev.virtualizedfx.list -
Immutable object to represent the state of a
VFXListState
in a specific moment in time. - VFXListState(VFXList<T, C>, IntegerRange) - Constructor for class io.github.palexdev.virtualizedfx.list.VFXListState
- VFXListStateProperty<T,
C> - Class in io.github.palexdev.virtualizedfx.properties -
Convenience property that extends
ReadOnlyObjectWrapper
forVFXListState
. - VFXListStateProperty() - Constructor for class io.github.palexdev.virtualizedfx.properties.VFXListStateProperty
- VFXListStateProperty(VFXListState<T, C>) - Constructor for class io.github.palexdev.virtualizedfx.properties.VFXListStateProperty
- VFXListStateProperty(Object, String) - Constructor for class io.github.palexdev.virtualizedfx.properties.VFXListStateProperty
- VFXListStateProperty(Object, String, VFXListState<T, C>) - Constructor for class io.github.palexdev.virtualizedfx.properties.VFXListStateProperty
- VFXPaginatedList<T,
C> - Class in io.github.palexdev.virtualizedfx.list.paginated -
Simple and naive implementation of a paginated variant of
VFXList
. - VFXPaginatedList() - Constructor for class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedList
- VFXPaginatedList(ObservableList<T>, Function<T, C>) - Constructor for class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedList
- VFXPaginatedList(ObservableList<T>, Function<T, C>, Orientation) - Constructor for class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedList
- VFXPaginatedListHelper<T,
C> - Interface in io.github.palexdev.virtualizedfx.list.paginated -
Simple extension of
VFXListHelper
with to concrete implementationsVFXPaginatedListHelper.VerticalHelper
andVFXPaginatedListHelper.HorizontalHelper
to override the behavior ofVFXListHelper.visibleNum()
, so that it always returns the value of cells per page (VFXPaginatedList.cellsPerPageProperty()
). - VFXPaginatedListHelper.HorizontalHelper<T,
C> - Class in io.github.palexdev.virtualizedfx.list.paginated - VFXPaginatedListHelper.VerticalHelper<T,
C> - Class in io.github.palexdev.virtualizedfx.list.paginated - VFXPaginatedListManager<T,
C> - Class in io.github.palexdev.virtualizedfx.list.paginated -
Default behavior implementation for
VFXPaginatedList
, extendsVFXListManager
. - VFXPaginatedListManager(VFXPaginatedList<T, C>) - Constructor for class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListManager
- VFXPaginatedListSkin<T,
C> - Class in io.github.palexdev.virtualizedfx.list.paginated -
Default skin implementation for the paginated variant of
VFXList
:VFXPaginatedList
. - VFXPaginatedListSkin(VFXPaginatedList<T, C>) - Constructor for class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListSkin
- viewport - Variable in class io.github.palexdev.virtualizedfx.list.VFXListSkin
- viewportPosition - Variable in class io.github.palexdev.virtualizedfx.list.VFXListHelper.AbstractHelper
- viewportPositionProperty() - Method in class io.github.palexdev.virtualizedfx.list.VFXListHelper.AbstractHelper
- viewportPositionProperty() - Method in interface io.github.palexdev.virtualizedfx.list.VFXListHelper
-
Cells are actually contained in a separate pane called 'viewport'.
- VirtualizedFX - module VirtualizedFX
- visibleNum() - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListHelper.HorizontalHelper
- visibleNum() - Method in class io.github.palexdev.virtualizedfx.list.paginated.VFXPaginatedListHelper.VerticalHelper
- visibleNum() - Method in class io.github.palexdev.virtualizedfx.list.VFXListHelper.HorizontalHelper
- visibleNum() - Method in class io.github.palexdev.virtualizedfx.list.VFXListHelper.VerticalHelper
- visibleNum() - Method in interface io.github.palexdev.virtualizedfx.list.VFXListHelper
- vPosProperty() - Method in class io.github.palexdev.virtualizedfx.list.VFXList
-
Specifies the container's vertical position.
All Classes and Interfaces|All Packages|Serialized Form