com.toolsverse.mvc.controller

Interface ControllerAdapter

All Known Implementing Classes:

ControllerAdapterImpl

public interface ControllerAdapter

In the Toolseverse implementation of the MVC the ControllerAdapter is where you put all event handlers and model to view and view to model data conversion. The way you do this is by adding annotations ViewAction, ConvertForDisplay and ConvertForStorage to the methods of the particular ControllerAdapter implementations. The ControllerAdapter implementation must be registered in the instance of the Controller interface.

Since:

2.0

Version:

2.0

See Also:

ViewAction, ConvertForDisplay, ConvertForStorage

Method Summary

Modifier and Type	Method and Description
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	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.

Method Detail

convertForDisplay

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

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.

Parameters:

controller - the controller

attributeName - the attribute name

input - the input

Returns:

the object

convertForDisplayAnnotation

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

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

Parameters:

controller - the controller

attributeName - the attribute name

input - the input

Returns:

the object

convertForStorage

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

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.

Parameters:

controller - the controller

attributeName - the attribute name

input - the input

Returns:

the object

convertForStorageAnnotation

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

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

Parameters:

controller - the controller

attributeName - the attribute name

input - the input

Returns:

the object

getAttributes

Map<String,Object> getAttributes()

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

Returns:

the attributes

isEnabled

boolean isEnabled()

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

Returns:

true, if is enabled

isInitializing

boolean isInitializing()

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

Returns:

true, if is initializing

setEnabled

void setEnabled(boolean enabled)

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

Parameters:

enabled - the new enabled

setIsInitializing

void setIsInitializing(boolean value)

Sets the checks if is initializing.

Parameters:

value - the new checks if is initializing

supportsActionAnnotation

boolean supportsActionAnnotation(String attributeName)

Returns true if ViewAction annotation is supported for the attribute.

Parameters:

attributeName - the attribute name

Returns:

true, if successful

supportsConvertForDisplayAnnotation

boolean supportsConvertForDisplayAnnotation(String attributeName)

Returns true if ConvertForDisplay annotation is supported for the attribute.

Parameters:

attributeName - the attribute name

Returns:

true, if successful

supportsConvertForStorageAnnotation

boolean supportsConvertForStorageAnnotation(String attributeName)

Returns true if ConvertForStorage annotation is supported for the attribute.

Parameters:

attributeName - the attribute name

Returns:

true, if successful

viewAction

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

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

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

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

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

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.