Module org.autogui

Package org.autogui.swing.mapping

Class GuiReprValueDocumentEditor

java.lang.Object

org.autogui.base.mapping.GuiReprValue

org.autogui.swing.mapping.GuiReprValueDocumentEditor

All Implemented Interfaces:

GuiRepresentation

public class GuiReprValueDocumentEditor
extends GuiReprValue

a GUI representation for a property holding a Document, AbstractDocument.Content, or a StringBuilder. the representation depends on some Swing classes(java.desktop module)

      StyledDocument doc;
      @GuiIncluded public StyledDocument getDoc() {
          if (doc == null) {
              doc = new DefaultStyledDocument();
          }
          return doc;
      }

      @GuiIncluded public StringContent content = new StringContent();

      @GuiIncluded public StringBuilder builder = new StringBuilder();
  

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GuiReprValueDocumentEditor.ContentInsertEdit	an undoable insertion operation for GuiReprValueDocumentEditor.StringBuilderContent
static class	GuiReprValueDocumentEditor.ContentPosition	a position implementation with an offset
static class	GuiReprValueDocumentEditor.ContentRemoveEdit	an undoable removing operation for GuiReprValueDocumentEditor.StringBuilderContent
static class	GuiReprValueDocumentEditor.ContentWrappingDocument	a styled-document impl.
static interface	GuiReprValueDocumentEditor.EditSupplier<T>	a functional interface used in GuiReprValueDocumentEditor.StringBuilderContent
static class	GuiReprValueDocumentEditor.StringBuilderContent	a content for StringBuilder: wraps a buffer and manages any changes to the buffer.
static class	GuiReprValueDocumentEditor.UndoContentPosition	a saved position for GuiReprValueDocumentEditor.ContentPosition.

Nested classes/interfaces inherited from class org.autogui.base.mapping.GuiReprValue

GuiReprValue.NamedValue, GuiReprValue.ObjectSpecifier, GuiReprValue.ObjectSpecifierIndex, GuiReprValue.ObjectSpecifierNothing

Nested classes/interfaces inherited from interface org.autogui.base.mapping.GuiRepresentation

GuiRepresentation.GuiReprNone

Field Summary

Fields

Modifier and Type	Field	Description
static TabSet	tabSet

Fields inherited from class org.autogui.base.mapping.GuiReprValue

NONE, NONE_WITH_CACHE

Constructor Summary

Constructors

Constructor	Description
GuiReprValueDocumentEditor()

Method Summary

Modifier and Type	Method	Description
Object	fromHumanReadableString(GuiMappingContext context, String str)
Object	fromJson(GuiMappingContext context, Object target, Object json)	create a new value object from the JSON with treating the target as an old value, or update the target with the JSON contents.
Object	fromJsonInEvent(GuiMappingContext context, Object target, Object json)
static TabSet	getTabSet()
GuiUpdatedValue	getValue(GuiMappingContext context, GuiMappingContext.GuiSourceValue parentSource, GuiReprValue.ObjectSpecifier specifier, GuiMappingContext.GuiSourceValue prev)	obtain the property value from parentSource as an owner.
boolean	isHistoryValueStored(Object value)
boolean	isStyledDocument(GuiMappingContext context)
boolean	isTaskRunnerUsedFor(Supplier<?> task)
boolean	matchValueType(Class<?> cls)
void	setSource(GuiMappingContext context, Object value)
static boolean	setupStyle(Style style)
static void	setupStyle(StyledDocument doc)
String	toHumanReadableString(GuiMappingContext context, Object source)	method for constructing "toString" copy operations: the returned string will be separated by tabs and new-lines
Object	toJson(GuiMappingContext context, Object source)	convert the source into JSON format
Object	toJsonInEvent(Object source)
Object	toSourceValue(GuiMappingContext context, Document document)
Document	toUpdateValue(GuiMappingContext context, Object value)	called from a GUI element in order to update its value.
Document	toUpdateValue(GuiMappingContext context, Object value, Consumer<Document> delayed)
Object	update(GuiMappingContext context, GuiMappingContext.GuiSourceValue parentSource, Object newValue, GuiReprValue.ObjectSpecifier specifier)	set a new value to a property of an object, which specified by the context using GuiMappingContext.execute(Callable) if the type is a GuiTypeMemberProperty, update the property by GuiTypeMemberProperty.executeSet(Object, Object) if parent is a property GuiReprPropertyPane or a collection element GuiReprCollectionElement, obtain the parent source of the parent, and update the parent with the source and newValue.

Methods inherited from class org.autogui.base.mapping.GuiReprValue

addHistoryValue, castOrMake, checkAndUpdateSource, convertLog, createNewValue, errorWhileAddHistoryValue, fromSource, fromSourceUpdated, getNoneSupplier, getParentSource, getUpdatedSource, getUpdatedValue, getUpdatedValueWithoutNoUpdate, getValueCollectionElement, getValueCollectionSize, getValueType, getValueWithoutNoUpdate, isEditable, isFromJsonTakingMapWithContextNameEntry, isHistoryValueStored, isHistoryValueSupported, isHistoryValueSupported, isUpdateContextSourceByUpdateFromGui, match, notifyUpdateWithParentSourceNone, toParentSource, toSource, toString, unwrapNoUpdate, updateCollectionElement, updateFromGui, updateWithParentSource

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.autogui.base.mapping.GuiRepresentation

continueCheckAndUpdateSourceForChildren, fromJsonWithNamed, isJsonSetter, matchAndSetNotifiersAsInit, setNotifiersTree, shutdown, toJsonWithNamed, toStringHeader

Field Details

tabSet

public static TabSet tabSet

Constructor Details

GuiReprValueDocumentEditor

public GuiReprValueDocumentEditor()

Method Details

isTaskRunnerUsedFor

public boolean isTaskRunnerUsedFor(Supplier<?> task)

Parameters:

task - the tested task

Returns:

true if the task can be executed under the task-runner of a context. the method can be used for the cases that the task is dispatched to a custom task-runner mechanism

matchValueType

public boolean matchValueType(Class<?> cls)

Overrides:

matchValueType in class GuiReprValue

getValue

public GuiUpdatedValue getValue(GuiMappingContext context,
 GuiMappingContext.GuiSourceValue parentSource,
 GuiReprValue.ObjectSpecifier specifier,
 GuiMappingContext.GuiSourceValue prev)
                         throws Throwable

Description copied from class: GuiReprValue

obtain the property value from parentSource as an owner.

In this class, support following cases:

• the type is a GuiTypeMemberProperty
• other types: use methods of GuiTypeValue with prev and parentSource as the inherited value

Overrides:

getValue in class GuiReprValue

Parameters:

context - the context holding the repr.

parentSource - the property owner. if no value then nothing will happen for properties

specifier - the specifier of the value

prev - a previous value compared to the obtained value

Returns:

an obtained property value (nullable) or GuiUpdatedValue.NO_UPDATE if the value is equivalent to the previous value.

Throws:

Throwable - might be caused by executing method invocations.

update

public Object update(GuiMappingContext context,
 GuiMappingContext.GuiSourceValue parentSource,
 Object newValue,
 GuiReprValue.ObjectSpecifier specifier)

Description copied from class: GuiReprValue

set a new value to a property of an object, which specified by the context

• using GuiMappingContext.execute(Callable)
• if the type is a GuiTypeMemberProperty, update the property by GuiTypeMemberProperty.executeSet(Object, Object)
• if parent is a property GuiReprPropertyPane or a collection element GuiReprCollectionElement, obtain the parent source of the parent, and update the parent with the source and newValue. This will be done by parent's GuiReprValue.updateWithParentSource(GuiMappingContext, Object, ObjectSpecifier)
• otherwise call GuiTypeValue.writeValue(Object, Object) or a similar method

Overrides:

update in class GuiReprValue

Parameters:

context - the target context

parentSource - the property owner

newValue - a new value to be set to the property

specifier - the specifier of the value

Returns:

newValue which will need to be passed to GuiMappingContext.updateSourceFromGui(Object), or null if error

isHistoryValueStored

public boolean isHistoryValueStored(Object value)

Overrides:

isHistoryValueStored in class GuiReprValue

Parameters:

value - the tested value, or null at loading

Returns:

if true, actually the value is stored to the preferences store

setSource

public void setSource(GuiMappingContext context,
 Object value)

Overrides:

setSource in class GuiReprValue

toUpdateValue

public Document toUpdateValue(GuiMappingContext context,
 Object value)

Description copied from class: GuiReprValue

called from a GUI element in order to update its value. subclass can change to returned type and convert the value to the type. a typical use case is just down-casting and converting null to an empty object.

Overrides:

toUpdateValue in class GuiReprValue

Parameters:

context - the context of the repr.

value - the current value

Returns:

the updated value

toUpdateValue

public Document toUpdateValue(GuiMappingContext context,
 Object value,
 Consumer<Document> delayed)

toSourceValue

public Object toSourceValue(GuiMappingContext context,
 Document document)

isStyledDocument

public boolean isStyledDocument(GuiMappingContext context)

toJson

public Object toJson(GuiMappingContext context,
 Object source)

Description copied from interface: GuiRepresentation

convert the source into JSON format

Specified by:

toJson in interface GuiRepresentation

Overrides:

toJson in class GuiReprValue

Parameters:

context - a context holds the representation

source - the converted object

Returns:

document text String

toJsonInEvent

public Object toJsonInEvent(Object source)

toHumanReadableString

public String toHumanReadableString(GuiMappingContext context,
 Object source)

Description copied from interface: GuiRepresentation

method for constructing "toString" copy operations: the returned string will be separated by tabs and new-lines

Parameters:

context - the context of the repr.

source - converted to string

Returns:

a string representation of the source

fromHumanReadableString

public Object fromHumanReadableString(GuiMappingContext context,
 String str)

fromJson

public Object fromJson(GuiMappingContext context,
 Object target,
 Object json)

Description copied from interface: GuiRepresentation

create a new value object from the JSON with treating the target as an old value, or update the target with the JSON contents. the behavior can be varied by each representation, confirmed by GuiRepresentation.isJsonSetter().

Specified by:

fromJson in interface GuiRepresentation

Overrides:

fromJson in class GuiReprValue

Parameters:

context - a context holds the representation

target - the target object or null

json - JSON objects representing the target String, Number, Boolean, List, Map or null

Returns:

created object from the json, target if provided, or null.

fromJsonInEvent

public Object fromJsonInEvent(GuiMappingContext context,
 Object target,
 Object json)

getTabSet

public static TabSet getTabSet()

setupStyle

public static boolean setupStyle(Style style)

setupStyle

public static void setupStyle(StyledDocument doc)