org.uberfire.client.workbench.docks

Interface UberfireDocks

public interface UberfireDocks

Uberfire Dock Support

Method Summary

Modifier and Type	Method and Description
void	add(UberfireDock... docks) Adds a UberfireDock to UberfireDocks.
void	close(UberfireDock dock) Close a UberfireDock from a given perspective.
void	hide(UberfireDockPosition position, String perspectiveName) Hides the docks bar associated with UberfireDockPosition for a given perspective.
void	open(UberfireDock dock) Open a UberfireDock from a given perspective.
void	remove(UberfireDock... docks) Removes a UberfireDock from UberfireDocks.
void	show(UberfireDockPosition position, String perspectiveName) Shows the docks bar associated with UberfireDockPosition for a given perspective.
void	toggle(UberfireDock dock) Toggle a UberfireDock from a given perspective.

Method Detail

add

void add(UberfireDock... docks)

Adds a UberfireDock to UberfireDocks. Each UberfireDock is displayed after the associated Perspective is loaded.

Parameters:

docks - one or more docks to be added.

remove

void remove(UberfireDock... docks)

Removes a UberfireDock from UberfireDocks.

Parameters:

docks - one or more docks to be added.

open

void open(UberfireDock dock)

Open a UberfireDock from a given perspective. This opens the PlaceRequest associated with the given dock on the docks panel.

Parameters:

dock - that will be selected.

close

void close(UberfireDock dock)

Close a UberfireDock from a given perspective. This closes the PlaceRequest associated with the given dock and the docks panel.

Parameters:

dock - that will be deselected.

toggle

void toggle(UberfireDock dock)

Toggle a UberfireDock from a given perspective. Switch from open/close a dock

Parameters:

dock - that will be deselected.

hide

void hide(UberfireDockPosition position,
          String perspectiveName)

Hides the docks bar associated with UberfireDockPosition for a given perspective.

Parameters:

position - the dock position that will be hidden.

perspectiveName - pespective that the dock will be hidden.

show

void show(UberfireDockPosition position,
          String perspectiveName)

Shows the docks bar associated with UberfireDockPosition for a given perspective.

Parameters:

position - the dock position that will be shown.

perspectiveName - perspective that the dock will be shown.