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

Class JsonStringField<T extends IStringField>

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

org.eclipse.scout.rt.ui.html.json.form.fields.JsonFormField<VALUE_FIELD>

org.eclipse.scout.rt.ui.html.json.form.fields.JsonValueField<T>

org.eclipse.scout.rt.ui.html.json.form.fields.JsonBasicField<T>

org.eclipse.scout.rt.ui.html.json.form.fields.stringfield.JsonStringField<T>

All Implemented Interfaces:

IJsonAdapter<T>, IJsonObject, IJsonContextMenuOwner, IBinaryResourceConsumer, IUploadable

public class JsonStringField<T extends IStringField>
extends JsonBasicField<T>
implements IBinaryResourceConsumer

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 final String	EVENT_ACTION
static final String	EVENT_SELECTION_CHANGE
static final String	OBFUSCATED_DISPLAY_TEXT	Characters to use for obfuscated display text

Fields inherited from class org.eclipse.scout.rt.ui.html.json.form.fields.JsonValueField

EVENT_ACCEPT_INPUT

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
JsonStringField(T model, IUiSession uiSession, String id, IJsonAdapter<?> parent)

Method Summary

Modifier and Type	Method	Description
void	consumeBinaryResource(List<org.eclipse.scout.rt.platform.resource.BinaryResource> binaryResources, Map<String,String> uploadProperties)
long	getMaximumUploadSize()
String	getObjectType()	Returns a string used to identify the object-type in the JSON output (JSON attribute 'objectType').
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	handleUiAcceptInputAfterTyping(String displayText)	Called by the UI when the displayText has changed and the editing action has finished ( whileTyping = false).
protected void	handleUiAcceptInputWhileTyping(String displayText)	Called by the UI when the displayText has changed but the editing action has not yet finished ( whileTyping = true).
protected void	handleUiAction()
void	handleUiEvent(JsonEvent event)
protected void	handleUiSelectionChange(JsonEvent event)
protected void	initJsonProperties(T model)
protected boolean	isObfuscateDisplayTextRequired()
JSONObject	toJson()

Methods inherited from class org.eclipse.scout.rt.ui.html.json.form.fields.JsonValueField

handleUiAcceptInput, handleUiDisplayTextChange, handleUiErrorStatusChange, handleUiValueChange, jsonToValue, setDisplayTextFromUI, setErrorStatusFromUI, setValueFromUI

Methods inherited from class org.eclipse.scout.rt.ui.html.json.form.fields.JsonFormField

attachChildAdapters, attachModel, detachModel, disposeChildAdapters, handleModelContextMenuChanged, handleModelContextMenuCurrentMenuTypesChanged, handleModelContextMenuVisibleChanged, menuTypesToJson

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

Methods inherited from interface org.eclipse.scout.rt.ui.html.res.IUploadable

getAcceptedUploadFileExtensions

Field Details

EVENT_ACTION

public static final String EVENT_ACTION

See Also:

• Constant Field Values

EVENT_SELECTION_CHANGE

public static final String EVENT_SELECTION_CHANGE

See Also:

• Constant Field Values

OBFUSCATED_DISPLAY_TEXT

public static final String OBFUSCATED_DISPLAY_TEXT

Characters to use for obfuscated display text

See Also:

• Constant Field Values

Constructor Details

JsonStringField

public JsonStringField(T model,
 IUiSession uiSession,
 String id,
 IJsonAdapter<?> parent)

Method Details

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

Overrides:

getObjectType in class JsonValueField<T extends IStringField>

initJsonProperties

protected void initJsonProperties(T model)

Overrides:

initJsonProperties in class JsonBasicField<T extends IStringField>

handleUiEvent

public void handleUiEvent(JsonEvent event)

Specified by:

handleUiEvent in interface IJsonAdapter<T extends IStringField>

Overrides:

handleUiEvent in class JsonValueField<T extends IStringField>

handleUiAction

protected void handleUiAction()

handleUiSelectionChange

protected void handleUiSelectionChange(JsonEvent event)

handleUiAcceptInputWhileTyping

protected void handleUiAcceptInputWhileTyping(String displayText)

Description copied from class: JsonValueField

Called by the UI when the displayText has changed but the editing action has not yet finished ( whileTyping = true). The model field does not yet change its value. This method is usually only called when the IBasicField.PROP_UPDATE_DISPLAY_TEXT_ON_MODIFY flag is set.

Overrides:

handleUiAcceptInputWhileTyping in class JsonValueField<T extends IStringField>

handleUiAcceptInputAfterTyping

protected void handleUiAcceptInputAfterTyping(String displayText)

Description copied from class: JsonValueField

Called by the UI when the displayText has changed and the editing action has finished ( whileTyping = false). The model field parses the displayText and updates its value.

Overrides:

handleUiAcceptInputAfterTyping in class JsonValueField<T extends IStringField>

consumeBinaryResource

public void consumeBinaryResource(List<org.eclipse.scout.rt.platform.resource.BinaryResource> binaryResources,
 Map<String,String> uploadProperties)

Specified by:

consumeBinaryResource in interface IBinaryResourceConsumer

getMaximumUploadSize

public long getMaximumUploadSize()

Specified by:

getMaximumUploadSize in interface IUploadable

Returns:

maximum upload size in bytes

toJson

public JSONObject toJson()

Specified by:

toJson in interface IJsonAdapter<T extends IStringField>

Specified by:

toJson in interface IJsonObject

Overrides:

toJson in class JsonFormField<T extends IStringField>

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

handleModelPropertyChange

protected void handleModelPropertyChange(PropertyChangeEvent event)

Overrides:

handleModelPropertyChange in class JsonFormField<T extends IStringField>

isObfuscateDisplayTextRequired

protected boolean isObfuscateDisplayTextRequired()