com.toolsverse.mvc.controller

Class ControllerAdapterImpl

Object

com.toolsverse.mvc.controller.ControllerAdapterImpl

All Implemented Interfaces:

ControllerAdapter

public abstract class ControllerAdapterImpl
extends Object
implements ControllerAdapter

The abstract implementation of the ControllerAdapter interface.

Since:

2.0

Version:

2.0

Constructor Summary

Constructors

Constructor and Description
ControllerAdapterImpl() Instantiates a new ControllerAdapterImpl.

Method Summary

Modifier and Type	Method and Description
Object	addComponent(View view, Object component) Adds the component.
Object	addComponent(View view, Object component, long behavior) Adds the component using behavior modifier.
void	addControllerAdapters(View view) Registers itself in the view and initializes MVC.
Object	convertForDisplay(Controller controller, String attributeName, Object input) Converts value before sending it to the view.
Object	convertForDisplayAnnotation(Controller controller, String attributeName, Object input) Converts value before sending it to the view.
Object	convertForStorage(Controller controller, String attributeName, Object input) Converts value before sending it to the model.
Object	convertForStorageAnnotation(Controller controller, String attributeName, Object input) Converts value before sending it to the model.
Map<String,Object>	getAttributes() Gets the attributes.
boolean	isEnabled() Checks if ControllerAdapter is enabled.
boolean	isInitializing() Checks if controller is in process of initialization.
void	removeComponent(View view, Object component) Removes the component.
void	removeControllerAdapters(View view) Removes the controller adapter.
void	replaceAttrNames(String suffix) Replaces attribute names using adapre's substitution map and a suffix.
void	replaceAttrNames(String suffix, Map<String,String> map, boolean exclude) Replaces attribute names using given substitution map, suffix and a exclude flag.
void	setEnabled(boolean enabled) Sets the enabled flag.
void	setIsInitializing(boolean value) Sets the checks if is initializing.
boolean	supportsActionAnnotation(String attributeName) Returns true if ViewAction annotation is supported for the attribute.
boolean	supportsConvertForDisplayAnnotation(String attributeName) Returns true if ConvertForDisplay annotation is supported for the attribute.
boolean	supportsConvertForStorageAnnotation(String attributeName) Returns true if ConvertForStorage annotation is supported for the attribute.
boolean	viewAction(Controller controller, Object source, String attributeName) This is an event handler for all action events.
boolean	viewAnnotationAction(Controller controller, Object source, String attributeName) Event handler for the particular action event.

Methods inherited from class Object

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

Constructor Detail

ControllerAdapterImpl

public ControllerAdapterImpl()

Instantiates a new ControllerAdapterImpl.

Method Detail

addComponent

public Object addComponent(View view,
                           Object component)

Adds the component.

Parameters:

view - the view

component - the component

Returns:

the object

addComponent

public Object addComponent(View view,
                           Object component,
                           long behavior)

Adds the component using behavior modifier.

Parameters:

view - the view

component - the component

behavior - the behavior modifier

Returns:

the object

addControllerAdapters

public void addControllerAdapters(View view)

Registers itself in the view and initializes MVC.

Parameters:

view - the view

convertForDisplay

public Object convertForDisplay(Controller controller,
                                String attributeName,
                                Object input)

Description copied from interface: ControllerAdapter

Converts value before sending it to the view. Regularly no conversion require so value is just passing through. You can implement this method and check attribute name but better way is to use ConvertForDisplay annotation.

Specified by:

convertForDisplay in interface ControllerAdapter

Parameters:

controller - the controller

attributeName - the attribute name

input - the input

Returns:

the object

convertForDisplayAnnotation

public final Object convertForDisplayAnnotation(Controller controller,
                                                String attributeName,
                                                Object input)

Description copied from interface: ControllerAdapter

Converts value before sending it to the view. The method is called by MVC framework and mark as final in the ControllerAdapterImpl.

Specified by:

convertForDisplayAnnotation in interface ControllerAdapter

Parameters:

controller - the controller

attributeName - the attribute name

input - the input

Returns:

the object

convertForStorage

public Object convertForStorage(Controller controller,
                                String attributeName,
                                Object input)

Description copied from interface: ControllerAdapter

Converts value before sending it to the model. Regularly no conversion require so value is just passing through. You can implement this method and check attribute name but better way is to use ConvertForStorage annotation.

Specified by:

convertForStorage in interface ControllerAdapter

Parameters:

controller - the controller

attributeName - the attribute name

input - the input

Returns:

the object

convertForStorageAnnotation

public final Object convertForStorageAnnotation(Controller controller,
                                                String attributeName,
                                                Object input)

Description copied from interface: ControllerAdapter

Converts value before sending it to the model. The method is called by MVC framework and mark as final in the ControllerAdapterImpl.

Specified by:

convertForStorageAnnotation in interface ControllerAdapter

Parameters:

controller - the controller

attributeName - the attribute name

input - the input

Returns:

the object

getAttributes

public Map<String,Object> getAttributes()

Description copied from interface: ControllerAdapter

Gets the attributes. The key is an attribute name, the value is usually null.

Specified by:

getAttributes in interface ControllerAdapter

Returns:

the attributes

isEnabled

public boolean isEnabled()

Description copied from interface: ControllerAdapter

Checks if ControllerAdapter is enabled. It is not the events and values from the models and views will not be crossing.

Specified by:

isEnabled in interface ControllerAdapter

Returns:

true, if is enabled

isInitializing

public boolean isInitializing()

Description copied from interface: ControllerAdapter

Checks if controller is in process of initialization. At this time there should be no interaction between models and views.

Specified by:

isInitializing in interface ControllerAdapter

Returns:

true, if is initializing

removeComponent

public void removeComponent(View view,
                            Object component)

Removes the component.

Parameters:

view - the view

component - the component

removeControllerAdapters

public void removeControllerAdapters(View view)

Removes the controller adapter.

Parameters:

view - the view

replaceAttrNames

public void replaceAttrNames(String suffix)

Replaces attribute names using adapre's substitution map and a suffix. Used when model is cloned or copied but it is not possible to reuse original names of the attributes. For example in the web mode where each UI element in the html must have a unique name.

Parameters:

suffix - the suffix

replaceAttrNames

public void replaceAttrNames(String suffix,
                             Map<String,String> map,
                             boolean exclude)

Replaces attribute names using given substitution map, suffix and a exclude flag. Used when model is cloned or copied but it is not possible to reuse original names of the attributes. For example in the web mode where each UI element in the html must have a unique name.

Parameters:

suffix - the suffix

map - the substitution map

exclude - the exclude flag

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: ControllerAdapter

Sets the enabled flag. It it is not enabled the events and values from the models and views will not be crossing.

Specified by:

setEnabled in interface ControllerAdapter

Parameters:

enabled - the new enabled

setIsInitializing

public void setIsInitializing(boolean value)

Description copied from interface: ControllerAdapter

Sets the checks if is initializing.

Specified by:

setIsInitializing in interface ControllerAdapter

Parameters:

value - the new checks if is initializing

supportsActionAnnotation

public final boolean supportsActionAnnotation(String attributeName)

Description copied from interface: ControllerAdapter

Returns true if ViewAction annotation is supported for the attribute.

Specified by:

supportsActionAnnotation in interface ControllerAdapter

Parameters:

attributeName - the attribute name

Returns:

true, if successful

supportsConvertForDisplayAnnotation

public final boolean supportsConvertForDisplayAnnotation(String attributeName)

Description copied from interface: ControllerAdapter

Returns true if ConvertForDisplay annotation is supported for the attribute.

Specified by:

supportsConvertForDisplayAnnotation in interface ControllerAdapter

Parameters:

attributeName - the attribute name

Returns:

true, if successful

supportsConvertForStorageAnnotation

public final boolean supportsConvertForStorageAnnotation(String attributeName)

Description copied from interface: ControllerAdapter

Returns true if ConvertForStorage annotation is supported for the attribute.

Specified by:

supportsConvertForStorageAnnotation in interface ControllerAdapter

Parameters:

attributeName - the attribute name

Returns:

true, if successful

viewAction

public boolean viewAction(Controller controller,
                          Object source,
                          String attributeName)

Description copied from interface: ControllerAdapter

This is an event handler for all action events. The better way is to use ViewAction annotation.

Specified by:

viewAction in interface ControllerAdapter

Parameters:

controller - the controller

source - the source

attributeName - the attribute name

Returns:

true, if action is handled for the particular event so it stops right there and not pushed further.

viewAnnotationAction

public final boolean viewAnnotationAction(Controller controller,
                                          Object source,
                                          String attributeName)

Description copied from interface: ControllerAdapter

Event handler for the particular action event. The method is final in the ControllerAdapterImpl.

Specified by:

viewAnnotationAction in interface ControllerAdapter

Parameters:

controller - the controller

source - the source

attributeName - the attribute name

Returns:

true, if action is handled for the particular event so it stops right there and not pushed further.