com.qcadoo.view.api

Interface ViewDefinitionState

All Superinterfaces:

ComponentMessagesHolder, ComponentState

public interface ViewDefinitionState
extends ComponentState

ViewDefinitionState is instance of single view. It is generated using ViewDefinition in request scope.

It contains all ComponentStates of this view and other data necessary display this view to client. Changing its data will also change state displayed to system user.

Since:

0.4.0

See Also:

ComponentState

Nested Class Summary

Nested classes/interfaces inherited from interface com.qcadoo.view.api.ComponentState

ComponentState.MessageType

Method Summary

Modifier and Type	Method and Description
ComponentState	getComponentByReference(String reference) Returns component state with specified reference name or null if no such component found
JSONObject	getJsonContext() Get context from url
boolean	isViewAfterRedirect() Checks whether the view is generated after redirect event
boolean	isViewAfterReload() Checks whether the view is generated for the first time or after reload
void	openModal(String url) Informs client that should open new modal window.
void	openModal(String url, Map<String,Object> parameters) Informs client that should open new modal window and pass custom component parameters.
void	redirectTo(String redirectToUrl, boolean openInNewWindow, boolean shouldSerialize) Informs client that should redirect to some url.
void	redirectTo(String redirectToUrl, boolean openInNewWindow, boolean shouldSerialize, Map<String,Object> parameters) Informs client that should redirect to some url and pass custom component parameters.
void	setJsonContext(JSONObject jSONObject) Set context form url
<T extends ComponentState> com.google.common.base.Optional<T>	tryFindComponentByReference(String reference) Returns Optional containing component with specified reference name or empty Optional if no such component found or found component has other type than demanded (see T type parameter).

Methods inherited from interface com.qcadoo.view.api.ComponentState

getFieldValue, getLocale, getName, getUuid, isEnabled, isHasError, isVisible, performEvent, setEnabled, setFieldValue, setVisible

Methods inherited from interface com.qcadoo.view.api.ComponentMessagesHolder

addMessage, addMessage, addMessage, addMessage, addMessage, addTranslatedMessage, addTranslatedMessage, addTranslatedMessage

Method Detail

getComponentByReference

ComponentState getComponentByReference(String reference)

Returns component state with specified reference name or null if no such component found

Parameters:

reference - reference name of component

Returns:

component state with specified reference name

getJsonContext

JSONObject getJsonContext()

Get context from url

Returns:

isViewAfterRedirect

boolean isViewAfterRedirect()

Checks whether the view is generated after redirect event

Returns:

boolean

isViewAfterReload

boolean isViewAfterReload()

Checks whether the view is generated for the first time or after reload

Returns:

boolean

openModal

void openModal(String url)

Informs client that should open new modal window.

Parameters:

url - target url of opened window

openModal

void openModal(String url,
               Map<String,Object> parameters)

Informs client that should open new modal window and pass custom component parameters.

Parameters:

url - target url of opened window

redirectTo

void redirectTo(String redirectToUrl,
                boolean openInNewWindow,
                boolean shouldSerialize)

Informs client that should redirect to some url.

Parameters:

redirectToUrl - target url of redirection

openInNewWindow - true if client should open given url in new window

shouldSerialize - true if before this redirection client should save window state

redirectTo

void redirectTo(String redirectToUrl,
                boolean openInNewWindow,
                boolean shouldSerialize,
                Map<String,Object> parameters)

Informs client that should redirect to some url and pass custom component parameters.

Parameters:

redirectToUrl - target url of redirection

openInNewWindow - true if client should open given url in new window

shouldSerialize - true if before this redirection client should save window state

parameters - map of parameters which be passed between views

setJsonContext

void setJsonContext(JSONObject jSONObject)

Set context form url

Parameters:

jSONObject -

tryFindComponentByReference

<T extends ComponentState> com.google.common.base.Optional<T> tryFindComponentByReference(String reference)

Returns Optional containing component with specified reference name or empty Optional if no such component found or found component has other type than demanded (see T type parameter).

Parameters:

reference - reference name of component

Returns:

component state with specified reference name wrapped within Optional, or Optional.absent() if no such component found or found component has other type than demanded.

Since:

1.3