Top Inners Fields Constructors Methods
org.jabref.gui.documentviewer

public Class DocumentViewerControl

extends StackPane
Class Inheritance
Imports
java.util.NoSuchElementException, .Objects, .Optional, javafx.animation.FadeTransition, javafx.beans.property.DoubleProperty, .ObjectProperty, .SimpleDoubleProperty, .SimpleObjectProperty, javafx.collections.ListChangeListener, .ObservableList, javafx.scene.control.ProgressIndicator, javafx.scene.image.Image, .ImageView, javafx.scene.input.ScrollEvent, javafx.scene.layout.StackPane, javafx.scene.shape.Rectangle, javafx.util.Duration, org.jabref.gui.util.BackgroundTask, .TaskExecutor, com.tobiasdiez.easybind.EasyBind, org.fxmisc.flowless.Cell, org.fxmisc.flowless.VirtualFlow, org.fxmisc.flowless.VirtualFlowHit

Nested and Inner Type Summary

Modifier and TypeClass and Description
private class
DocumentViewerControl.DocumentViewerPage

Represents the viewport for a page.

Field Summary

Modifier and TypeField and Description
private final ObjectProperty<Integer>
currentPage

private PageDimension
desiredPageDimension

private org.fxmisc.flowless.VirtualFlow<DocumentPageViewModel, DocumentViewerControl.DocumentViewerPage>
flow

private final DoubleProperty
scrollY

private final DoubleProperty
scrollYMax

private final TaskExecutor
taskExecutor

Constructor Summary

AccessConstructor and Description
public
DocumentViewerControl(TaskExecutor taskExecutor)

Method Summary

Modifier and TypeMethod and Description
public void
changePageWidth(int delta)

public ObjectProperty<Integer>
currentPageProperty()

public int
getCurrentPage()

public DoubleProperty
scrollYMaxProperty()

public DoubleProperty
scrollYProperty()

public void
setPageHeight(double height)

public void
setPageWidth(double width)

public void
show(DocumentViewModel document)

private void
showPage(int pageNumber)

private void
updateCurrentPage(ObservableList<DocumentViewerControl.DocumentViewerPage> visiblePages)

private void
updateSizeOfDisplayedPages()

Inherited from javafx.scene.layout.StackPane:
alignmentPropertyclearConstraintscomputeMinHeightcomputeMinWidthcomputePrefHeightcomputePrefWidthgetAlignmentgetAlignmentgetClassCssMetaDatagetContentBiasgetCssMetaDatagetMarginlayoutChildrenrequestLayoutsetAlignmentsetAlignmentsetMargin

Field Detail

currentPageback to summary
private final ObjectProperty<Integer> currentPage
desiredPageDimensionback to summary
private PageDimension desiredPageDimension
flowback to summary
private org.fxmisc.flowless.VirtualFlow<DocumentPageViewModel, DocumentViewerControl.DocumentViewerPage> flow
scrollYback to summary
private final DoubleProperty scrollY
scrollYMaxback to summary
private final DoubleProperty scrollYMax
taskExecutorback to summary
private final TaskExecutor taskExecutor

Constructor Detail

DocumentViewerControlback to summary
public DocumentViewerControl(TaskExecutor taskExecutor)

Method Detail

changePageWidthback to summary
public void changePageWidth(int delta)
currentPagePropertyback to summary
public ObjectProperty<Integer> currentPageProperty()
getCurrentPageback to summary
public int getCurrentPage()
scrollYMaxPropertyback to summary
public DoubleProperty scrollYMaxProperty()
scrollYPropertyback to summary
public DoubleProperty scrollYProperty()
setPageHeightback to summary
public void setPageHeight(double height)
setPageWidthback to summary
public void setPageWidth(double width)
showback to summary
public void show(DocumentViewModel document)
showPageback to summary
private void showPage(int pageNumber)
updateCurrentPageback to summary
private void updateCurrentPage(ObservableList<DocumentViewerControl.DocumentViewerPage> visiblePages)
updateSizeOfDisplayedPagesback to summary
private void updateSizeOfDisplayedPages()
org.jabref.gui.documentviewer back to summary

private Class DocumentViewerControl.DocumentViewerPage

extends Object
implements org.fxmisc.flowless.Cell<DocumentPageViewModel, StackPane>
Class Inheritance
  • java.lang.Object
  • org.jabref.gui.documentviewer.DocumentViewerControl.DocumentViewerPage
Represents the viewport for a page.

Note

the instances of DocumentViewerPage are reused, i.e., not every page is rendered in a new instance but instead DocumentViewerPage#updateItem(Object) is called.

Field Summary

Modifier and TypeField and Description
private final Rectangle
background

private final StackPane
imageHolder

private final ImageView
imageView

private DocumentPageViewModel
page

Constructor Summary

AccessConstructor and Description
public
DocumentViewerPage(DocumentPageViewModel initialPage)

Method Summary

Modifier and TypeMethod and Description
private int
getDesiredHeight()

private int
getDesiredWidth()

public StackPane
getNode()

public int
getPageNumber()

public boolean
isReusable()

private Image
renderPage(DocumentPageViewModel page)

public void
updateItem(DocumentPageViewModel page)

public void
updateSize()

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

backgroundback to summary
private final Rectangle background
imageHolderback to summary
private final StackPane imageHolder
imageViewback to summary
private final ImageView imageView
pageback to summary
private DocumentPageViewModel page

Constructor Detail

DocumentViewerPageback to summary
public DocumentViewerPage(DocumentPageViewModel initialPage)

Method Detail

getDesiredHeightback to summary
private int getDesiredHeight()
getDesiredWidthback to summary
private int getDesiredWidth()
getNodeback to summary
public StackPane getNode()
Annotations
@Override
getPageNumberback to summary
public int getPageNumber()
isReusableback to summary
public boolean isReusable()
Annotations
@Override
renderPageback to summary
private Image renderPage(DocumentPageViewModel page)
updateItemback to summary
public void updateItem(DocumentPageViewModel page)
Annotations
@Override
updateSizeback to summary
public void updateSize()