Package org.teamapps.ux.component.field.textcolormarker

Class TextColorMarkerField

java.lang.Object

org.teamapps.ux.component.AbstractComponent

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

org.teamapps.ux.component.field.textcolormarker.TextColorMarkerField

All Implemented Interfaces:

ClientObject, Component

public class TextColorMarkerField
extends AbstractField<TextColorMarkerFieldValue>

Field Summary

Fields

Modifier and Type	Field	Description
final Event<TextSelectionData>	onTextSelected

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
TextColorMarkerField()

Method Summary

Modifier and Type	Method	Description
TextColorMarkerFieldValue	convertUiValueToUxValue(Object value)
Object	convertUxValueToUiValue(TextColorMarkerFieldValue value)	Converts a server-side value to a client-side field-specific value.
UiTextColorMarkerField	createUiComponent()
TextSelectionData	getCurrentSelection()
TextSelectionData	getLastSelection()
List<TextColorMarkerDefinition>	getMarkerDefinitions()
void	handleUiEvent(UiEvent event)
boolean	isToolbarEnabled()
void	setMarker(int markerDefinitionId, int start, int end)
void	setMarkerDefinitions(List<TextColorMarkerDefinition> markerDefinitions)
void	setMarkerDefinitions(List<TextColorMarkerDefinition> markerDefinitions, TextColorMarkerFieldValue value)
void	setToolbarEnabled(boolean toolbarEnabled)
void	setValue(TextColorMarkerFieldValue value)

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

addCustomFieldMessage, addCustomFieldMessage, addValidator, applyValueFromUi, clearAllMessages, clearCustomFieldMessages, clearValidatorMessages, 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, 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

onTextSelected

public final Event<TextSelectionData> onTextSelected

Constructor Details

TextColorMarkerField

public TextColorMarkerField()

Method Details

createUiComponent

public UiTextColorMarkerField createUiComponent()

Specified by:

createUiComponent in class AbstractComponent

getMarkerDefinitions

public List<TextColorMarkerDefinition> getMarkerDefinitions()

setMarkerDefinitions

public void setMarkerDefinitions(List<TextColorMarkerDefinition> markerDefinitions,
 TextColorMarkerFieldValue value)

Parameters:

markerDefinitions - list of possible markers for this field

value - the field text and its markers

Throws:

IllegalTextColorMarkerException - if no matching definition was found

setMarkerDefinitions

public void setMarkerDefinitions(List<TextColorMarkerDefinition> markerDefinitions)

Parameters:

markerDefinitions - list of possible markers for this field

setMarker

public void setMarker(int markerDefinitionId,
 int start,
 int end)

Parameters:

markerDefinitionId - reference for the marker definition

start - text start position of the marker

end - text end position of the marker

Throws:

IllegalTextColorMarkerException - if no matching definition was found

getCurrentSelection

public TextSelectionData getCurrentSelection()

getLastSelection

public TextSelectionData getLastSelection()

isToolbarEnabled

public boolean isToolbarEnabled()

setToolbarEnabled

public void setToolbarEnabled(boolean toolbarEnabled)

setValue

public void setValue(TextColorMarkerFieldValue value)

Overrides:

setValue in class AbstractField<TextColorMarkerFieldValue>

Parameters:

value - text/markers to be set

Throws:

IllegalTextColorMarkerException - if markers are not valid

handleUiEvent

public void handleUiEvent(UiEvent event)

Specified by:

handleUiEvent in interface ClientObject

Overrides:

handleUiEvent in class AbstractField<TextColorMarkerFieldValue>

convertUiValueToUxValue

public TextColorMarkerFieldValue convertUiValueToUxValue(Object value)

Overrides:

convertUiValueToUxValue in class AbstractField<TextColorMarkerFieldValue>

convertUxValueToUiValue

public Object convertUxValueToUiValue(TextColorMarkerFieldValue value)

Description copied from class: AbstractField

Converts a server-side value to a client-side field-specific value. Implementations must not have any side effects to the component!

Overrides:

convertUxValueToUiValue in class AbstractField<TextColorMarkerFieldValue>

Parameters:

value - the server-side value

Returns:

the object to be sent to the ui