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

Class JsonTileGrid<T extends ITileGrid<? extends ITile>>

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

org.eclipse.scout.rt.ui.html.json.tile.JsonTileGrid<T>

All Implemented Interfaces:

IJsonAdapter<T>, IJsonObject, IJsonContextMenuOwner

public class JsonTileGrid<T extends ITileGrid<? extends ITile>>
extends AbstractJsonWidget<T>
implements IJsonContextMenuOwner

Since:

8.0

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_TILE_ACTION
static String	EVENT_TILE_CLICK

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

EVENT_REVEAL, EVENT_SCROLL_TO_TOP

Fields inherited from interface org.eclipse.scout.rt.ui.html.json.menu.IJsonContextMenuOwner

PROP_CURRENT_MENU_TYPES, PROP_MENUS, PROP_MENUS_VISIBLE

Constructor Summary

Constructors

Constructor	Description
JsonTileGrid(T model, IUiSession uiSession, String id, IJsonAdapter<?> parent)

Method Summary

Modifier and Type	Method	Description
protected void	attachChildAdapters()	Attach child adapters of this adapter instance here by calling the attachAdapter[s](model[s]) methods.
protected void	disposeChildAdapters()
protected MouseButton	extractMouseButton(JSONObject json)
protected ITile	extractTile(JSONObject json)
protected List<ITile>	extractTiles(JSONArray tileIds)
JsonContextMenu<IContextMenu>	getJsonContextMenu()
String	getObjectType()	Returns a string used to identify the object-type in the JSON output (JSON attribute 'objectType').
protected ITile	getTile(String tileId)
void	handleModelContextMenuChanged(FilteredJsonAdapterIds<?> filteredAdapters)
void	handleUiEvent(JsonEvent event)
protected void	handleUiPropertyChange(String propertyName, JSONObject data)	Override this method to handle property changes from the UI.
protected void	handleUiSelectedTiles(JSONObject data)
protected void	handleUiTileAction(JsonEvent event)
protected void	handleUiTileClick(JsonEvent event)
protected void	initJsonProperties(T model)
protected ITile	optTile(String tileId)
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, cleanUpEventFilters, filterPropertyChangeEvent, getCustomJsonProperties, getJsonProperty, handleLazyJsonProperties, handleModelPropertyChange, handleModelPropertyChange, 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, 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_TILE_CLICK

public static final String EVENT_TILE_CLICK

See Also:

Constant Field Values

EVENT_TILE_ACTION

public static final String EVENT_TILE_ACTION

See Also:

Constant Field Values

Constructor Detail

JsonTileGrid

public JsonTileGrid(T 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<T extends ITileGrid<? extends ITile>>

Overrides:

getObjectType in class AbstractJsonWidget<T extends ITileGrid<? extends ITile>>

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<T extends ITileGrid<? extends ITile>>

disposeChildAdapters

protected void disposeChildAdapters()

Overrides:

disposeChildAdapters in class AbstractJsonAdapter<T extends ITileGrid<? extends ITile>>

initJsonProperties

protected void initJsonProperties(T model)

Overrides:

initJsonProperties in class AbstractJsonWidget<T extends ITileGrid<? extends ITile>>

toJson

public JSONObject toJson()

Specified by:

toJson in interface IJsonAdapter<T extends ITileGrid<? extends ITile>>

Specified by:

toJson in interface IJsonObject

Overrides:

toJson in class AbstractJsonPropertyObserver<T extends ITileGrid<? extends ITile>>

handleUiEvent

public void handleUiEvent(JsonEvent event)

Specified by:

handleUiEvent in interface IJsonAdapter<T extends ITileGrid<? extends ITile>>

Overrides:

handleUiEvent in class AbstractJsonAdapter<T extends ITileGrid<? extends ITile>>

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<T extends ITileGrid<? extends ITile>>

handleUiSelectedTiles

protected void handleUiSelectedTiles(JSONObject data)

extractTiles

protected List<ITile> extractTiles(JSONArray tileIds)

handleUiTileClick

protected void handleUiTileClick(JsonEvent event)

extractMouseButton

protected MouseButton extractMouseButton(JSONObject json)

handleUiTileAction

protected void handleUiTileAction(JsonEvent event)

extractTile

protected ITile extractTile(JSONObject json)

getTile

protected ITile getTile(String tileId)

optTile

protected ITile optTile(String tileId)

handleModelContextMenuChanged

public void handleModelContextMenuChanged(FilteredJsonAdapterIds<?> filteredAdapters)

Specified by:

handleModelContextMenuChanged in interface IJsonContextMenuOwner

getJsonContextMenu

public JsonContextMenu<IContextMenu> getJsonContextMenu()