Module it.tidalwave.ui.core

Package it.tidalwave.ui.core

Interface PanelGroupControl<T>

Type Parameters:

T - the concrete type of the top container (depending on the UI technology)

All Known Subinterfaces:

JavaFXPanelGroupControl

All Known Implementing Classes:

PanelGroupControlSupport

@API(status=EXPERIMENTAL)
public interface PanelGroupControl<T>

This service looks up PanelGroupProviders that describe portions of the User Interface and places them in the desired region of the main window. Calling the method setup(Configuration) with the proper configuration, the desired panel groups can be bound to existing UI controls. The runtime will scan for instances of PanelGroupProvider that declare and instantiate panels to be associated to each group. Calling the method show(Object) one of possibly many panels in the same group is brought to visibility. If the system includes a message bus implementing MessageBus, it is also possible to pick the shown panel by publishing the event PanelShowRequest; the event PanelShownNotification will be published back to confirm the operation.

Since:

2.0-ALPHA-3

Author:

Fabrizio Giudici

See Also:

• PanelGroupProvider

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PanelGroupControl.Configuration<T>	A bag of configuration settings for PanelGroupProvider.
static enum	PanelGroupControl.DefaultGroups	Standard groups.
static interface	PanelGroupControl.Group	The group in the main window.
static enum	PanelGroupControl.Options	Options for the setup(Configuration) method.

Method Summary

Modifier and Type	Method	Description
default PanelGroupControl.Configuration<T>	config()	Returns an empty PanelGroupControl.Configuration.
void	setup(PanelGroupControl.Configuration<T> configuration)	Sets up panel groups according to the given PanelGroupControl.Configuration.
void	show(Object object)	Sets the shown object in a group.

Method Details

setup

void setup(@Nonnull
 PanelGroupControl.Configuration<T> configuration)

Sets up panel groups according to the given PanelGroupControl.Configuration.

Parameters:

configuration - the configuration

show

void show(@Nonnull
 Object object)

Sets the shown object in a group.

Parameters:

object - the object to show

config

@Nonnull
default PanelGroupControl.Configuration<T> config()

Returns an empty PanelGroupControl.Configuration..

Returns:

an empty PanelGroupControl.Configuration