public interface DMXViewManager
Modifier and Type | Field and Description |
---|---|
static String |
PARAM_DIALOG_TITLE
Name of the parameter which specifies optional title for a dialog.
|
static String |
PARAM_PROGRESS_DIALOG
Name of the parameter which specifies progress dialog operations.
|
static String |
PARAM_VIEW_STATE
Name of the parameter which specifies view state (active or inactive).
|
static int |
VAL_DLG_CLOSE
Indicates that progress dialog should be closed.
|
static int |
VAL_DLG_SHOW
Indicates that progress dialog should be shown.
|
Modifier and Type | Method and Description |
---|---|
void |
blockGui(boolean state,
GUIBlockingScope scope,
String... ids)
Block or unblock GUI based on specified parameters.
|
<T extends DialogFactory> |
getDialogFactory()
Retrieves dialog factory for the underlying platform.
|
DMXView |
getView(String id)
Returns a view with specified ID.
|
Set<String> |
getViewDataIds(String viewId)
Returns a list of data IDs that are required by specified view.
|
Set<String> |
getViewIdsForData(String dataId)
Returns a set of view IDs that refer to data with specified ID.
|
void |
handleLocaleChange()
Invoked when application locale is changed.
|
void |
registerEventHandler(DMXEventRegistrationHandler handler)
Registers event handler for UI components.
|
DMXView |
registerView(Class clazz)
Register view from specified class.
|
void |
registerView(DMXView view)
Registers specified view with this
ViewManager . |
void |
selectView(String viewId,
Map<String,Object> params)
Sets specified view as currently active for this
ViewManager . |
void |
setViewExtensionCallback(String viewId,
DMXExtensionCallback callback)
Sets extension callback of view with specified ID.
|
void |
updateView(String viewId,
Map<String,Object> dataValues)
Forces specified view to render itself due to change in model data.
|
void |
updateViewData(Map<String,Object> dataMap)
Updates views that depends on specified data.
|
static final String PARAM_PROGRESS_DIALOG
static final String PARAM_DIALOG_TITLE
static final String PARAM_VIEW_STATE
static final int VAL_DLG_SHOW
static final int VAL_DLG_CLOSE
void registerView(DMXView view)
ViewManager
. Registering the view means that
ViewManager
is responsible for managing it's state.view
- View
to registerDMXView registerView(Class clazz)
clazz
- class objectnull
if not successfulvoid selectView(String viewId, Map<String,Object> params)
Sets specified view as currently active for this
ViewManager
. Selecting the view will force it to be shown
(if not already) and render itself. Actual process of selecting the view is implementation
dependent and is out of the scope of this interface definition.
Parameters params
is a map of optional parameters which can be used by implementations
to determine conditions for selecting this view.
viewId
- name of the view to be shownparams
- optional parameters for selecting this viewDMXView getView(String id)
id
- view IDSet<String> getViewDataIds(String viewId)
viewId
- ID of the view for which data are requiredSet<String> getViewIdsForData(String dataId)
dataId
- data IDvoid updateView(String viewId, Map<String,Object> dataValues)
#selectView()
method, the view does not become active.viewId
- ID of the view to updatedataValues
- new data values to set for viewvoid updateViewData(Map<String,Object> dataMap)
dataMap
- data mapvoid setViewExtensionCallback(String viewId, DMXExtensionCallback callback)
Sets extension callback of view with specified ID. The call to callback's
DMXExtensionCallback.getExtensionType()
method must return
DMXExtensionType#VIEW_EXTENSION
.
viewId
- view IDcallback
- callback to registervoid handleLocaleChange()
void blockGui(boolean state, GUIBlockingScope scope, String... ids)
state
- whether to block or unblock GUI. If true
block, otherwise unblockscope
- blocking scopeids
- optional IDs of elements to block<T extends DialogFactory> T getDialogFactory()
T
- type of the implementation factoryDialogFactory
for the platformvoid registerEventHandler(DMXEventRegistrationHandler handler)
handler
contains information
on what handler should be registered and on which UI components.handler
- event handlerCopyright © 2012-2014 Vektor Software. All Rights Reserved.