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

Class JsonAction<ACTION extends IAction>

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<ACTION>

org.eclipse.scout.rt.ui.html.json.action.JsonAction<ACTION>

All Implemented Interfaces:

IJsonAdapter<ACTION>, IJsonObject, IBinaryResourceProvider

Direct Known Subclasses:

JsonBreadcrumbItem, JsonKeyStroke, JsonMenu, JsonMode, JsonTableControl, JsonViewButton

public abstract class JsonAction<ACTION extends IAction>
extends AbstractJsonWidget<ACTION>
implements IBinaryResourceProvider

Nested Class Summary

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_ACTION

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

EVENT_REVEAL, EVENT_SCROLL_TO_TOP

Constructor Summary

Constructors

Constructor	Description
JsonAction(ACTION model, IUiSession uiSession, String id, IJsonAdapter<?> parent)

Method Summary

Modifier and Type	Method	Description
protected String	getIconDesc()	Returns an URL for the image or iconId, respectively (first one that is not null).
String	getObjectType()	Returns a string used to identify the object-type in the JSON output (JSON attribute 'objectType').
protected void	handleModelIIconSourceChanged()
protected void	handleModelPropertyChange(PropertyChangeEvent event)
protected void	handleModelPropertyChange(String propertyName, Object oldValue, Object newValue)	This method is called, when a PropertyChangeEvent from the model occurs and no JsonProperty is registered for the given propertyName.
protected void	handleUiAction(JsonEvent event)
void	handleUiEvent(JsonEvent event)
protected void	handleUiPropertyChange(String propertyName, JSONObject data)	Override this method to handle property changes from the UI.
protected void	initJsonProperties(ACTION model)
BinaryResourceHolder	provideBinaryResource(String requestFilename)
JSONObject	toJson()

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

attachModel, detachModel, handleModelReveal, handleModelScrollTopTop, handleModelWidgetEvent, scrollOptionsToJson

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

addCustomJsonProperty, addPropertyChangeEvent, addPropertyChangeEvent, addPropertyEventFilterCondition, addPropertyEventFilterCondition, attachChildAdapters, cleanUpEventFilters, filterPropertyChangeEvent, getCustomJsonProperties, getJsonProperty, handleLazyJsonProperties, init, 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, 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

EVENT_ACTION

public static final String EVENT_ACTION

See Also:

Constant Field Values

Constructor Detail

JsonAction

public JsonAction(ACTION model,
                  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<ACTION extends IAction>

Overrides:

getObjectType in class AbstractJsonWidget<ACTION extends IAction>

initJsonProperties

protected void initJsonProperties(ACTION model)

Overrides:

initJsonProperties in class AbstractJsonWidget<ACTION extends IAction>

toJson

public JSONObject toJson()

Specified by:

toJson in interface IJsonAdapter<ACTION extends IAction>

Specified by:

toJson in interface IJsonObject

Overrides:

toJson in class AbstractJsonPropertyObserver<ACTION extends IAction>

handleUiEvent

public void handleUiEvent(JsonEvent event)

Specified by:

handleUiEvent in interface IJsonAdapter<ACTION extends IAction>

Overrides:

handleUiEvent in class AbstractJsonAdapter<ACTION extends IAction>

handleUiAction

protected void handleUiAction(JsonEvent event)

handleUiPropertyChange

protected void handleUiPropertyChange(String propertyName,
                                      JSONObject data)

Description copied from class: AbstractJsonAdapter

Override this method to handle property changes from the UI. You should use the get[Type] methods of the data JSONObject to retrieve the value. The default impl. does nothing.

Overrides:

handleUiPropertyChange in class AbstractJsonAdapter<ACTION extends IAction>

handleModelPropertyChange

protected void handleModelPropertyChange(PropertyChangeEvent event)

Overrides:

handleModelPropertyChange in class AbstractJsonPropertyObserver<ACTION extends IAction>

handleModelPropertyChange

protected void handleModelPropertyChange(String propertyName,
                                         Object oldValue,
                                         Object newValue)

Description copied from class: AbstractJsonPropertyObserver

This method is called, when a PropertyChangeEvent from the model occurs and no JsonProperty is registered for the given propertyName. Note that you must check if the property-change-event has been filtered by using the AbstractJsonPropertyObserver.filterPropertyChangeEvent(PropertyChangeEvent) method before you add an event to the JSON response. The default implementation does nothing.

Overrides:

handleModelPropertyChange in class AbstractJsonPropertyObserver<ACTION extends IAction>

handleModelIIconSourceChanged

protected void handleModelIIconSourceChanged()

getIconDesc

protected String getIconDesc()

Returns an URL for the image or iconId, respectively (first one that is not null). If no image is set, null is returned.

provideBinaryResource

public BinaryResourceHolder provideBinaryResource(String requestFilename)

Specified by:

provideBinaryResource in interface IBinaryResourceProvider