Package org.teamapps.ux.component.field.richtext

Class RichTextEditor

java.lang.Object

org.teamapps.ux.component.AbstractComponent

org.teamapps.ux.component.field.AbstractField<String>

org.teamapps.ux.component.field.richtext.RichTextEditor

All Implemented Interfaces:

ClientObject, Component

public class RichTextEditor
extends AbstractField<String>

Field Summary

Fields

Modifier and Type	Field	Description
final Event<ImageUploadFailedEventData>	onImageUploadFailed
final Event<ImageUploadStartedEventData>	onImageUploadStarted
final Event<ImageUploadSuccessfulEventData>	onImageUploadSuccessful
final Event<ImageUploadTooLargeEventData>	onImageUploadTooLarge
final Event<SpecialKey>	onSpecialKeyPressed
final Event<String>	onTextInput

Fields inherited from class org.teamapps.ux.component.field.AbstractField

onBlur, onFocus, onValueChanged, onVisibilityChanged

Fields inherited from class org.teamapps.ux.component.AbstractComponent

DELETED_ATTRIBUTE, onRendered

Constructor Summary

Constructors

Constructor	Description
RichTextEditor()

Method Summary

Modifier and Type	Method	Description
void	commitTransientValue(Consumer<String> callback)	Commits and returns (via callback) the transient value from the client side.
UiField	createUiComponent()
Locale	getLocale()
int	getMaxHeight()
int	getMaxImageFileSizeInBytes()
int	getMinHeight()
ToolbarVisibilityMode	getToolbarVisibilityMode()
com.ibm.icu.util.ULocale	getULocale()
UploadedFileToUrlConverter	getUploadedFileToUrlConverter()
String	getUploadUrl()
void	handleUiEvent(UiEvent event)
boolean	isImageUploadEnabled()
void	setFixedHeight(int height)
void	setImageUploadEnabled(boolean imageUploadEnabled)
void	setLocale(Locale locale)
void	setMaxHeight(int maxHeight)
void	setMaxImageFileSizeInBytes(int maxImageFileSizeInBytes)
void	setMinHeight(int minHeight)
void	setPrintPluginEnabled(boolean printPluginEnabled)
void	setToolbarVisibilityMode(ToolbarVisibilityMode toolbarVisibilityMode)
void	setULocale(com.ibm.icu.util.ULocale locale)
void	setUploadedFileToUrlConverter(UploadedFileToUrlConverter uploadedFileToUrlConverter)
void	setUploadUrl(String uploadUrl)

Methods inherited from class org.teamapps.ux.component.field.AbstractField

addCustomFieldMessage, addCustomFieldMessage, addValidator, applyValueFromUi, clearCustomFieldMessages, clearValidatorMessages, convertUiValueToUxValue, convertUxValueToUiValue, focus, getCustomFieldMessages, getDefaultMessagePosition, getDefaultMessageVisibility, getEditingMode, getFieldMessages, getMaxFieldMessageSeverity, getValidators, getValue, isEmpty, isEmptyValue, isRequired, isValid, isValueChangedByClient, isValueLocked, mapAbstractFieldAttributesToUiField, removeCustomFieldMessage, removeValidator, setAndLockValue, setCustomFieldMessages, setDefaultMessagePosition, setDefaultMessageVisibility, setEditingMode, setRequired, setRequiredIfVisibleAndEditable, setValue, setValueChangedByClient, setVisible, validate

Methods inherited from class org.teamapps.ux.component.AbstractComponent

createUiReference, getDebuggingId, getId, getParent, getSessionContext, isRendered, isVisible, mapAbstractUiComponentProperties, queueCommandIfRendered, render, reRenderIfRendered, setAttribute, setCssStyle, setDebuggingId, setParent, toggleCssClass, toString, unrender

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.teamapps.ux.component.ClientObject

handleUiQuery

Methods inherited from interface org.teamapps.ux.component.Component

setAriaLabel, setAttribute, setCssStyle, setHtmlTitle, setMargin, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setShadow, toggleCssClass

Field Details

onTextInput

public final Event<String> onTextInput

onSpecialKeyPressed

public final Event<SpecialKey> onSpecialKeyPressed

onImageUploadTooLarge

public final Event<ImageUploadTooLargeEventData> onImageUploadTooLarge

onImageUploadStarted

public final Event<ImageUploadStartedEventData> onImageUploadStarted

onImageUploadSuccessful

public final Event<ImageUploadSuccessfulEventData> onImageUploadSuccessful

onImageUploadFailed

public final Event<ImageUploadFailedEventData> onImageUploadFailed

Constructor Details

RichTextEditor

public RichTextEditor()

Method Details

createUiComponent

public UiField createUiComponent()

Specified by:

createUiComponent in class AbstractComponent

handleUiEvent

public void handleUiEvent(UiEvent event)

Specified by:

handleUiEvent in interface ClientObject

Overrides:

handleUiEvent in class AbstractField<String>

getToolbarVisibilityMode

public ToolbarVisibilityMode getToolbarVisibilityMode()

setToolbarVisibilityMode

public void setToolbarVisibilityMode(ToolbarVisibilityMode toolbarVisibilityMode)

getUploadedFileToUrlConverter

public UploadedFileToUrlConverter getUploadedFileToUrlConverter()

setUploadedFileToUrlConverter

public void setUploadedFileToUrlConverter(UploadedFileToUrlConverter uploadedFileToUrlConverter)

getUploadUrl

public String getUploadUrl()

setUploadUrl

public void setUploadUrl(String uploadUrl)

getMaxImageFileSizeInBytes

public int getMaxImageFileSizeInBytes()

setMaxImageFileSizeInBytes

public void setMaxImageFileSizeInBytes(int maxImageFileSizeInBytes)

getMinHeight

public int getMinHeight()

setMinHeight

public void setMinHeight(int minHeight)

getMaxHeight

public int getMaxHeight()

setMaxHeight

public void setMaxHeight(int maxHeight)

setFixedHeight

public void setFixedHeight(int height)

getLocale

public Locale getLocale()

getULocale

public com.ibm.icu.util.ULocale getULocale()

setLocale

public void setLocale(Locale locale)

setULocale

public void setULocale(com.ibm.icu.util.ULocale locale)

isImageUploadEnabled

public boolean isImageUploadEnabled()

setImageUploadEnabled

public void setImageUploadEnabled(boolean imageUploadEnabled)

commitTransientValue

public void commitTransientValue(Consumer<String> callback)

Commits and returns (via callback) the transient value from the client side.

setPrintPluginEnabled

public void setPrintPluginEnabled(boolean printPluginEnabled)