Package org.eclipse.scout.rt.ui.html.json.form

Class JsonForm<FORM extends IForm>

java.lang.Object

org.eclipse.scout.rt.ui.html.json.AbstractJsonAdapter<T>

org.eclipse.scout.rt.ui.html.json.AbstractJsonPropertyObserver<T>

org.eclipse.scout.rt.ui.html.json.AbstractJsonWidget<FORM>

org.eclipse.scout.rt.ui.html.json.form.JsonForm<FORM>

All Implemented Interfaces:

IJsonAdapter<FORM>, IJsonObject

Direct Known Subclasses:

JsonTileOverviewForm

public class JsonForm<FORM extends IForm>
extends AbstractJsonWidget<FORM>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	JsonForm.P_FormListener

Nested classes/interfaces inherited from class org.eclipse.scout.rt.ui.html.json.AbstractJsonWidget

AbstractJsonWidget.P_WidgetListener

Nested classes/interfaces inherited from class org.eclipse.scout.rt.ui.html.json.AbstractJsonPropertyObserver

AbstractJsonPropertyObserver.P_PropertyChangeListener

Field Summary

Fields

Modifier and Type	Field	Description
static String	EVENT_CLOSE
static String	EVENT_FORM_CLOSING
static String	EVENT_REQUEST_FOCUS
static String	EVENT_REQUEST_INPUT
static String	PROP_CACHE_BOUNDS
static String	PROP_CACHE_BOUNDS_KEY
static String	PROP_CLOSABLE
static String	PROP_DISPLAY_HINT
static String	PROP_DISPLAY_VIEW_ID
static String	PROP_FORM_FIELD
static String	PROP_FORM_ID
static String	PROP_ICON_ID
static String	PROP_INITIAL_FOCUS
static String	PROP_MODAL
static String	PROP_ROOT_GROUP_BOX
static String	PROP_SAVE_NEEDED
static String	PROP_SAVE_NEEDED_VISIBLE
static String	PROP_SUB_TITLE
static String	PROP_TITLE

Fields inherited from class org.eclipse.scout.rt.ui.html.json.AbstractJsonWidget

EVENT_REVEAL, EVENT_SCROLL_TO_TOP

Constructor Summary

Constructors

Constructor	Description
JsonForm(FORM form, IUiSession uiSession, String id, IJsonAdapter<?> parent)

Method Summary

Modifier and Type	Method	Description
protected void	addInitialInputEvent()
protected void	attachChildAdapters()	Attach child adapters of this adapter instance here by calling the attachAdapter[s](model[s]) methods.
protected void	attachModel()	Override this method in order to attach listeners on the Scout model object.
protected void	detachModel()
protected String	displayHintToJson(int displayHint)
protected IJsonAdapter<?>	findChildAdapter(FormEvent event)
protected FormEvent	findRecentEvent(int eventType)
String	getObjectType()	Returns a string used to identify the object-type in the JSON output (JSON attribute 'objectType').
protected String	getRequestEventName(int eventType)
protected void	handleModelFormChanged(FormEvent event)
protected void	handleModelFormClosed(IForm form)
protected void	handleModelRequestEvent(FormEvent event, boolean protect)
void	handleUiClose(JsonEvent event)
void	handleUiEvent(JsonEvent event)
void	handleUiFormClosing(JsonEvent event)
void	init()	Init method which is called by the factory after the constructor has been executed.
protected void	initJsonProperties(FORM model)
protected void	setInitialFocusProperty(JSONObject json)
JSONObject	toJson()

Methods inherited from class org.eclipse.scout.rt.ui.html.json.AbstractJsonWidget

handleModelReveal, handleModelScrollTopTop, handleModelWidgetEvent, scrollOptionsToJson

Methods inherited from class org.eclipse.scout.rt.ui.html.json.AbstractJsonPropertyObserver

addCustomJsonProperty, addPropertyChangeEvent, addPropertyChangeEvent, addPropertyEventFilterCondition, addPropertyEventFilterCondition, cleanUpEventFilters, filterPropertyChangeEvent, getCustomJsonProperties, getJsonProperty, handleLazyJsonProperties, handleModelPropertyChange, handleModelPropertyChange, putJsonProperty, removeCustomJsonProperty, removeJsonProperty, responseAlreadyContainsPropertyChangeEvent

Methods inherited from class org.eclipse.scout.rt.ui.html.json.AbstractJsonAdapter

addActionEvent, addActionEvent, addActionEvent, addPropertyChangeEvent, attachAdapter, attachAdapter, attachAdapters, attachAdapters, attachGlobalAdapter, attachGlobalAdapter, attachGlobalAdapters, attachGlobalAdapters, dispose, disposeChildAdapters, getAdapter, getAdapter, getAdapters, getAdapters, getGlobalAdapter, getGlobalAdapter, getId, getModel, getObjectTypeVariant, getParent, getUiSession, handleUiPropertyChange, handleUiPropertyChange, hasAncestor, isDisposed, isInitialized, processBufferedEvents, putAdapterIdProperty, putAdapterIdProperty, putAdapterIdsProperty, putAdapterIdsProperty, putProperty, registerAsBufferedEventsAdapter, replaceActionEvent, toString, unregisterAsBufferedEventsAdapter

Methods inherited from class java.lang.Object

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

Field Detail

PROP_FORM_ID

public static final String PROP_FORM_ID

See Also:

Constant Field Values

PROP_TITLE

public static final String PROP_TITLE

See Also:

Constant Field Values

PROP_SUB_TITLE

public static final String PROP_SUB_TITLE

See Also:

Constant Field Values

PROP_ICON_ID

public static final String PROP_ICON_ID

See Also:

Constant Field Values

PROP_CLOSABLE

public static final String PROP_CLOSABLE

See Also:

Constant Field Values

PROP_SAVE_NEEDED_VISIBLE

public static final String PROP_SAVE_NEEDED_VISIBLE

See Also:

Constant Field Values

PROP_MODAL

public static final String PROP_MODAL

See Also:

Constant Field Values

PROP_DISPLAY_HINT

public static final String PROP_DISPLAY_HINT

See Also:

Constant Field Values

PROP_DISPLAY_VIEW_ID

public static final String PROP_DISPLAY_VIEW_ID

See Also:

Constant Field Values

PROP_SAVE_NEEDED

public static final String PROP_SAVE_NEEDED

See Also:

Constant Field Values

PROP_CACHE_BOUNDS

public static final String PROP_CACHE_BOUNDS

See Also:

Constant Field Values

PROP_CACHE_BOUNDS_KEY

public static final String PROP_CACHE_BOUNDS_KEY

See Also:

Constant Field Values

PROP_FORM_FIELD

public static final String PROP_FORM_FIELD

See Also:

Constant Field Values

PROP_ROOT_GROUP_BOX

public static final String PROP_ROOT_GROUP_BOX

See Also:

Constant Field Values

PROP_INITIAL_FOCUS

public static final String PROP_INITIAL_FOCUS

See Also:

Constant Field Values

EVENT_FORM_CLOSING

public static final String EVENT_FORM_CLOSING

See Also:

Constant Field Values

EVENT_CLOSE

public static final String EVENT_CLOSE

See Also:

Constant Field Values

EVENT_REQUEST_FOCUS

public static final String EVENT_REQUEST_FOCUS

See Also:

Constant Field Values

EVENT_REQUEST_INPUT

public static final String EVENT_REQUEST_INPUT

See Also:

Constant Field Values

Constructor Detail

JsonForm

public JsonForm(FORM form,
                IUiSession uiSession,
                String id,
                IJsonAdapter<?> parent)

Method Detail

getObjectType

public String getObjectType()

Description copied from interface: IJsonAdapter

Returns a string used to identify the object-type in the JSON output (JSON attribute 'objectType').

Specified by:

getObjectType in interface IJsonAdapter<FORM extends IForm>

Overrides:

getObjectType in class AbstractJsonWidget<FORM extends IForm>

init

public void init()

Description copied from interface: IJsonAdapter

Init method which is called by the factory after the constructor has been executed. The default implementation calls attachModel() and attachChildAdapters().

Specified by:

init in interface IJsonAdapter<FORM extends IForm>

Overrides:

init in class AbstractJsonPropertyObserver<FORM extends IForm>

initJsonProperties

protected void initJsonProperties(FORM model)

Overrides:

initJsonProperties in class AbstractJsonWidget<FORM extends IForm>

attachChildAdapters

protected void attachChildAdapters()

Description copied from class: AbstractJsonAdapter

Attach child adapters of this adapter instance here by calling the attachAdapter[s](model[s]) methods. This will also create a new JSON adapter instance when the adapter does not yet exist for the given model.

Overrides:

attachChildAdapters in class AbstractJsonPropertyObserver<FORM extends IForm>

attachModel

protected void attachModel()

Description copied from class: AbstractJsonAdapter

Override this method in order to attach listeners on the Scout model object. At this point a JsonAdapter instance has been already created for the model object. The default implementation does nothing.

Overrides:

attachModel in class AbstractJsonWidget<FORM extends IForm>

detachModel

protected void detachModel()

Overrides:

detachModel in class AbstractJsonWidget<FORM extends IForm>

toJson

public JSONObject toJson()

Specified by:

toJson in interface IJsonAdapter<FORM extends IForm>

Specified by:

toJson in interface IJsonObject

Overrides:

toJson in class AbstractJsonPropertyObserver<FORM extends IForm>

addInitialInputEvent

protected void addInitialInputEvent()

setInitialFocusProperty

protected void setInitialFocusProperty(JSONObject json)

findChildAdapter

protected IJsonAdapter<?> findChildAdapter(FormEvent event)

findRecentEvent

protected FormEvent findRecentEvent(int eventType)

displayHintToJson

protected String displayHintToJson(int displayHint)

handleModelFormChanged

protected void handleModelFormChanged(FormEvent event)

handleModelFormClosed

protected void handleModelFormClosed(IForm form)

handleModelRequestEvent

protected void handleModelRequestEvent(FormEvent event,
                                       boolean protect)

getRequestEventName

protected String getRequestEventName(int eventType)

handleUiEvent

public void handleUiEvent(JsonEvent event)

Specified by:

handleUiEvent in interface IJsonAdapter<FORM extends IForm>

Overrides:

handleUiEvent in class AbstractJsonAdapter<FORM extends IForm>

handleUiFormClosing

public void handleUiFormClosing(JsonEvent event)

handleUiClose

public void handleUiClose(JsonEvent event)