Package net.ssehub.easy.dslCore.ui.listeners

Class BasicModelLoadingListener<M extends IModel>

java.lang.Object

net.ssehub.easy.dslCore.ui.listeners.BasicModelLoadingListener<M>

Type Parameters:

M - the model type

All Implemented Interfaces:

IModelProcessingListener<M>, IAggregatableListener

public class BasicModelLoadingListener<M extends IModel>
extends java.lang.Object
implements IModelProcessingListener<M>, IAggregatableListener

Generically implements a model processing (loading) listener which disables UI controls.

Author:

Holger Eichelberger

Nested Class Summary

Nested classes/interfaces inherited from interface net.ssehub.easy.basics.modelManagement.IModelProcessingListener

IModelProcessingListener.Type

Field Summary

Fields

Modifier and Type	Field	Description
private IControl	control
private ModelInfo<M>	info
private ModelManagement<M>	mgt
private IModelProcessingListener.Type[]	types

Constructor Summary

Constructors

Constructor	Description
BasicModelLoadingListener(ModelInfo<M> info, ModelManagement<M> mgt, IControl control)	Creates a generic listener.
BasicModelLoadingListener(ModelInfo<M> info, ModelManagement<M> mgt, IControl control, IModelProcessingListener.Type[] types)	Creates a generic listener.

Method Summary

Modifier and Type	Method	Description
static <M extends IModel> BasicModelLoadingListener<M>	createListener(ModelInfo<M> info, ModelManagement<M> mgt, IControl control, IModelProcessingListener.Type... types)	Creates a generic listener.
static <M extends IModel> BasicModelLoadingListener<M>	createLoadingListener(ModelInfo<M> info, ModelManagement<M> mgt, IControl control)	Creates a model loading listener.
void	dispose()	Disposes this listener, i.e., deregisters it.
void	initialize()	Initializes this listener.
private boolean	inTypes(IModelProcessingListener.Type type)	Whether type is in types.
void	notifyProcessingEnded(ModelInfo<M> info, IModelProcessingListener.Type type)	Is called when processing ended (or shortly after).
void	notifyProcessingStarted(ModelInfo<M> info, IModelProcessingListener.Type type)	Is called when processing started (or shortly before).

Methods inherited from class java.lang.Object

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

Field Detail

control

private IControl control

info

private ModelInfo<M extends IModel> info

mgt

private ModelManagement<M extends IModel> mgt

types

private IModelProcessingListener.Type[] types

Constructor Detail

BasicModelLoadingListener

public BasicModelLoadingListener(ModelInfo<M> info,
                                 ModelManagement<M> mgt,
                                 IControl control)

Creates a generic listener. Either use AggregatingModelLoadingListener or call initialize() afterwards (but not both). Reacts on all message types.

Parameters:

info - the model information object to listen on

mgt - the related model management object

control - the control to be enabled and disabled

BasicModelLoadingListener

public BasicModelLoadingListener(ModelInfo<M> info,
                                 ModelManagement<M> mgt,
                                 IControl control,
                                 IModelProcessingListener.Type[] types)

Creates a generic listener. Either use AggregatingModelLoadingListener or call initialize() afterwards (but not both).

Parameters:

info - the model information object to listen on

mgt - the related model management object

control - the control to be enabled and disabled

types - message types causing enabled messages (may be null)

Method Detail

createListener

public static <M extends IModel> BasicModelLoadingListener<M> createListener(ModelInfo<M> info,
                                                                             ModelManagement<M> mgt,
                                                                             IControl control,
                                                                             IModelProcessingListener.Type... types)

Creates a generic listener. [convenience method]

Type Parameters:

M - the model type

Parameters:

info - the model information object to listen on

mgt - the related model management object

control - the control to be enabled and disabled

types - message types causing enabled messages (may be null)

Returns:

the created listener

createLoadingListener

public static <M extends IModel> BasicModelLoadingListener<M> createLoadingListener(ModelInfo<M> info,
                                                                                    ModelManagement<M> mgt,
                                                                                    IControl control)

Creates a model loading listener. [convenience method]

Type Parameters:

M - the model type

Parameters:

info - the model information object to listen on

mgt - the related model management object

control - the control to be enabled and disabled

Returns:

the created listener

initialize

public void initialize()

Initializes this listener.

Specified by:

initialize in interface IAggregatableListener

inTypes

private boolean inTypes(IModelProcessingListener.Type type)

Whether type is in types.

Parameters:

type - the type to look for

Returns:

true if type is a contained type, false else

notifyProcessingStarted

public void notifyProcessingStarted(ModelInfo<M> info,
                                    IModelProcessingListener.Type type)

Description copied from interface: IModelProcessingListener

Is called when processing started (or shortly before).

Specified by:

notifyProcessingStarted in interface IModelProcessingListener<M extends IModel>

Parameters:

info - the model information

type - the processing type

notifyProcessingEnded

public void notifyProcessingEnded(ModelInfo<M> info,
                                  IModelProcessingListener.Type type)

Description copied from interface: IModelProcessingListener

Is called when processing ended (or shortly after).

Specified by:

notifyProcessingEnded in interface IModelProcessingListener<M extends IModel>

Parameters:

info - the model information

type - the processing type

dispose

public void dispose()

Disposes this listener, i.e., deregisters it.

Specified by:

dispose in interface IAggregatableListener