Top Description Inners Constructors Methods
org.controlsfx.dialog

public Class ProgressDialog

extends Dialog<Void>
Class Inheritance
Static Imports
impl.org.controlsfx.i18n.Localization.getString
Progress Dialog to report on the progress of any background Worker.
After the given Worker finishes, the Progress Dialog automatically closes.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
ProgressDialog.WorkerProgressPane

The WorkerProgressPane takes a Dialog and a Worker and links them together so the dialog is shown or hidden depending on the state of the worker.

Constructor Summary

AccessConstructor and Description
public
ProgressDialog(final Worker<?> worker)

Method Summary

Inherited from javafx.scene.control.Dialog:
addEventFilteraddEventHandlerbuildEventDispatchChainclosecontentTextPropertydialogPanePropertygetContentTextgetDialogPanegetGraphicgetHeaderTextgetHeightgetModalitygetOnCloseRequestgetOnHiddengetOnHidinggetOnShowinggetOnShowngetOwnergetResultgetResultConvertergetTitlegetWidthgetXgetYgraphicPropertyheaderTextPropertyheightPropertyhideinitModalityinitOwnerinitStyleisResizableisShowingonCloseRequestPropertyonHiddenPropertyonHidingPropertyonShowingPropertyonShownPropertyremoveEventFilterremoveEventHandlerresizablePropertyresultConverterPropertyresultPropertysetContentTextsetDialogPanesetGraphicsetHeaderTextsetHeightsetOnCloseRequestsetOnHiddensetOnHidingsetOnShowingsetOnShownsetResizablesetResultsetResultConvertersetTitlesetWidthsetXsetYshowshowAndWaitshowingPropertytitlePropertywidthPropertyxPropertyyProperty

Constructor Detail

ProgressDialogback to summary
public ProgressDialog(final Worker<?> worker)
org.controlsfx.dialog back to summary

private Class ProgressDialog.WorkerProgressPane

extends Region
Class Inheritance
The WorkerProgressPane takes a Dialog and a Worker and links them together so the dialog is shown or hidden depending on the state of the worker. The WorkerProgressPane also includes a progress bar that is automatically bound to the progress property of the worker. The way in which the WorkerProgressPane shows and hides its worker's dialog is consistent with the expected behavior for showWorkerProgress(Worker).

Field Summary

Modifier and TypeField and Description
private boolean
cancelDialogShow

private final ProgressDialog
dialog

private boolean
dialogVisible

private final ProgressBar
progressBar

private ChangeListener<Worker.State>
stateListener

private Worker<?>
worker

Inherited from javafx.scene.layout.Region:
USE_COMPUTED_SIZEUSE_PREF_SIZE

Constructor Summary

AccessConstructor and Description
public
WorkerProgressPane(ProgressDialog dialog)

Method Summary

Modifier and TypeMethod and Description
private void
begin()

private void
end()

protected void
layoutChildren()

Overrides javafx.scene.Parent.layoutChildren.

Invoked during the layout pass to layout the children in this Parent.

public final void
setWorker(final Worker<?> newWorker)

Inherited from javafx.scene.layout.Region:
backgroundPropertyborderPropertycacheShapePropertycenterShapePropertycomputeMaxHeightcomputeMaxWidthcomputeMinHeightcomputeMinWidthcomputePrefHeightcomputePrefWidthgetBackgroundgetBordergetClassCssMetaDatagetCssMetaDatagetHeightgetInsetsgetMaxHeightgetMaxWidthgetMinHeightgetMinWidthgetOpaqueInsetsgetPaddinggetPrefHeightgetPrefWidthgetShapegetUserAgentStylesheetgetWidthheightPropertyinsetsPropertyisCacheShapeisCenterShapeisResizableisScaleShapeisSnapToPixellayoutInArealayoutInArealayoutInArealayoutInAreamaxHeightmaxHeightPropertymaxWidthmaxWidthPropertyminHeightminHeightPropertyminWidthminWidthPropertyopaqueInsetsPropertypaddingPropertypositionInAreapositionInAreaprefHeightprefHeightPropertyprefWidthprefWidthPropertyresizescaleShapePropertysetBackgroundsetBordersetCacheShapesetCenterShapesetHeightsetMaxHeightsetMaxSizesetMaxWidthsetMinHeightsetMinSizesetMinWidthsetOpaqueInsetssetPaddingsetPrefHeightsetPrefSizesetPrefWidthsetScaleShapesetShapesetSnapToPixelsetWidthshapePropertysnappedBottomInsetsnappedLeftInsetsnappedRightInsetsnappedTopInsetsnapPositionsnapPositionXsnapPositionYsnapSizesnapSizeXsnapSizeYsnapSpacesnapSpaceXsnapSpaceYsnapToPixelPropertywidthProperty

Field Detail

cancelDialogShowback to summary
private boolean cancelDialogShow
dialogback to summary
private final ProgressDialog dialog
dialogVisibleback to summary
private boolean dialogVisible
progressBarback to summary
private final ProgressBar progressBar
stateListenerback to summary
private ChangeListener<Worker.State> stateListener
workerback to summary
private Worker<?> worker

Constructor Detail

WorkerProgressPaneback to summary
public WorkerProgressPane(ProgressDialog dialog)

Method Detail

beginback to summary
private void begin()
endback to summary
private void end()
layoutChildrenback 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
setWorkerback to summary
public final void setWorker(final Worker<?> newWorker)