Package net.officefloor.gef.editor.internal.views

Class ViewersComposite

java.lang.Object

net.officefloor.gef.editor.internal.views.ViewersComposite

All Implemented Interfaces:

AdaptedErrorHandler

public class ViewersComposite
extends java.lang.Object
implements AdaptedErrorHandler

Composite of the viewers.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested classes/interfaces inherited from interface net.officefloor.gef.editor.AdaptedErrorHandler

AdaptedErrorHandler.MessageOnlyException, AdaptedErrorHandler.UncertainOperation

Constructor Summary

Constructors

Constructor	Description
ViewersComposite(org.eclipse.gef.mvc.fx.viewer.IViewer contentViewer, org.eclipse.gef.mvc.fx.viewer.IViewer paletteViewer, SelectOnly selectOnly)	Instantiate.

Method Summary

Modifier and Type	Method	Description
javafx.scene.layout.Pane	getComposite()	Obtains the Pane containing the view.
javafx.scene.layout.Pane	getPaletteIndicator()	Obtains the palette indicator Pane.
void	init(boolean isCreateParents)	Initialises.
boolean	isError(AdaptedErrorHandler.UncertainOperation operation)	Runs an AdaptedErrorHandler.UncertainOperation.
void	loadComplete()	Indicates loading complete so may show errors.
void	showError(java.lang.String message)	Shows the error.
void	showError(java.lang.Throwable error)	Shows the error.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ViewersComposite

public ViewersComposite(org.eclipse.gef.mvc.fx.viewer.IViewer contentViewer,
                        org.eclipse.gef.mvc.fx.viewer.IViewer paletteViewer,
                        SelectOnly selectOnly)

Instantiate.

Parameters:

contentViewer - IViewer for the editor.

paletteViewer - IViewer for the palette.

selectOnly - SelectOnly. May be null.

Method Detail

init

public void init(boolean isCreateParents)

Initialises.

Parameters:

isCreateParents - Flag indicate whether able to create AdaptedParent instances.

getPaletteIndicator

public javafx.scene.layout.Pane getPaletteIndicator()

Obtains the palette indicator Pane.

Returns:

Palette indicator Pane.

getComposite

public javafx.scene.layout.Pane getComposite()

Obtains the Pane containing the view.

Returns:

Pane containing the view.

loadComplete

public void loadComplete()

Indicates loading complete so may show errors.

showError

public void showError(java.lang.String message)

Description copied from interface: AdaptedErrorHandler

Shows the error.

Specified by:

showError in interface AdaptedErrorHandler

Parameters:

message - Error message to show.

showError

public void showError(java.lang.Throwable error)

Description copied from interface: AdaptedErrorHandler

Shows the error.

Specified by:

showError in interface AdaptedErrorHandler

Parameters:

error - Throwable error to show.

isError

public boolean isError(AdaptedErrorHandler.UncertainOperation operation)

Description copied from interface: AdaptedErrorHandler

Runs an AdaptedErrorHandler.UncertainOperation.

 UncertainOperation operation = () -> { ... };
 if (handler.isError(operation) {
          return; // failure in operation
 }
 

Specified by:

isError in interface AdaptedErrorHandler

Parameters:

operation - AdaptedErrorHandler.UncertainOperation.

Returns:

true if AdaptedErrorHandler.UncertainOperation threw an Exception. The Exception will displayed visually to the user.