Module org.autogui

Package org.autogui.base.mapping

Class GuiReprObjectPane

java.lang.Object

org.autogui.base.mapping.GuiReprValue

org.autogui.base.mapping.GuiReprObjectPane

All Implemented Interfaces:

GuiRepresentation

Direct Known Subclasses:

GuiReprObjectTabbedPane

public class GuiReprObjectPane
extends GuiReprValue

an object representation composing member sub-representations

     @GuiIncluded
     public class C {
         @GuiIncluded public String prop;

         String v;
         @GuiIncluded public String getValue() { return v; };
         @GuiIncluded public void setValue(String v) { this.v = v; };

         @GuiIncluded public void action() {...};
         ...
     }
 

Nested Class Summary

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, GuiRepresentation.TreeString, GuiRepresentation.TreeStringComposite, GuiRepresentation.TreeStringValue

Field Summary

Fields

Modifier and Type	Field	Description
protected GuiRepresentation	subRepresentation

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

NONE, NONE_WITH_CACHE

Constructor Summary

Constructors

Constructor	Description
GuiReprObjectPane()
GuiReprObjectPane(GuiRepresentation subRepresentation)

Method Summary

Modifier and Type	Method	Description
Object	fromHumanReadableString(GuiMappingContext context, String str)
static Object	fromHumanReadableStringToObject(GuiMappingContext context, String str)
Object	fromJson(GuiMappingContext context, Object target, Object json)	use fromJsonToObject(GuiMappingContext, Object, Object)
static Object	fromJsonToObject(GuiMappingContext context, Object target, Object json)	constructing an object or setting up the target object from the JSON.
static BiConsumer<GuiMappingContext,Object>	getAddingHumanReadableStringToList(List<GuiRepresentation.TreeString> list)
static GuiReprValue	getReprValue(GuiRepresentation repr)
boolean	isHistoryValueStored(Object value)
boolean	isHistoryValueSupported()
boolean	match(GuiMappingContext context)	match the representation with the typeElement of the context, and if succeeded, it sets this representation to the context, and it might create sub-contexts for recursive matches *
protected boolean	matchWithoutSetting(GuiMappingContext context)
static void	runSubCollectionValue(GuiMappingContext subContext, Object source, BiConsumer<GuiMappingContext,Object> subAndNext)
static void	runSubPropertyValue(GuiMappingContext subContext, Object source, BiConsumer<GuiMappingContext,Object> subAndNext)
void	shutdown(GuiMappingContext context, Object source)	do shutting-down process if the target object is an AutoCloseable.
static String	toHumanReadableStringFromObject(GuiMappingContext context, Object source)	constructing a human-readable string representation of the object.
GuiRepresentation.TreeString	toHumanReadableStringTree(GuiMappingContext context, Object source)	use toHumanReadableStringFromObject(GuiMappingContext, Object)
static GuiRepresentation.TreeString	toHumanReadableStringTreeFromObject(GuiMappingContext context, Object source)	called from toHumanReadableStringFromObject(GuiMappingContext, Object)
Object	toJson(GuiMappingContext context, Object source)	use toJsonFromObject(GuiMappingContext, Object)
static Object	toJsonFromObject(GuiMappingContext context, Object source)
String	toString()
static Object	unwrapPropertyMap(GuiMappingContext s, Object subObj)

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

addHistoryValue, castOrMake, checkAndUpdateSource, convertLog, createNewValue, errorWhileAddHistoryValue, fromSource, fromSourceUpdated, getNoneSupplier, getParentSource, getUpdatedSource, getUpdatedValue, getUpdatedValueWithoutNoUpdate, getValue, getValueCollectionElement, getValueCollectionSize, getValueType, getValueWithoutNoUpdate, isEditable, isFromJsonTakingMapWithContextNameEntry, isHistoryValueStored, isHistoryValueSupported, isUpdateContextSourceByUpdateFromGui, matchValueType, notifyUpdateWithParentSourceNone, setSource, toParentSource, toSource, toUpdateValue, unwrapNoUpdate, update, 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, isTaskRunnerUsedFor, matchAndSetNotifiersAsInit, setNotifiersTree, toHumanReadableString, toJsonWithNamed, toStringHeader

Field Details

subRepresentation

protected GuiRepresentation subRepresentation

Constructor Details

GuiReprObjectPane

public GuiReprObjectPane(GuiRepresentation subRepresentation)

GuiReprObjectPane

public GuiReprObjectPane()

Method Details

match

public boolean match(GuiMappingContext context)

Description copied from interface: GuiRepresentation

match the representation with the typeElement of the context, and if succeeded, it sets this representation to the context, and it might create sub-contexts for recursive matches *

Specified by:

match in interface GuiRepresentation

Overrides:

match in class GuiReprValue

Parameters:

context - the context of the repr.

Returns:

the matching result

matchWithoutSetting

protected boolean matchWithoutSetting(GuiMappingContext context)

isHistoryValueSupported

public boolean isHistoryValueSupported()

Overrides:

isHistoryValueSupported in class GuiReprValue

Returns:

if true, GuiReprValue.updateFromGui(GuiMappingContext, Object, ObjectSpecifier, GuiTaskClock) automatically add the value to the preferences. the default impl. returns true.

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

toJson

public Object toJson(GuiMappingContext context,
 Object source)

use toJsonFromObject(GuiMappingContext, Object)

Specified by:

toJson in interface GuiRepresentation

Overrides:

toJson in class GuiReprValue

Parameters:

context - a context holds the representation

source - the converted object

Returns:

Map: { propertyName: propertyJson }

toJsonFromObject

public static Object toJsonFromObject(GuiMappingContext context,
 Object source)

Parameters:

context - the context of the caller's repr.

source - the converted object

Returns:

a map object (LinkedHashMap), with entries based on the child contexts. a member is constructed with GuiRepresentation.toJsonWithNamed(GuiMappingContext, Object). Special case: if the map has only 1 collection entry, then it will return the entry value (list) instead of the map. This is because the entry name will be the type name and useless.

unwrapPropertyMap

public static Object unwrapPropertyMap(GuiMappingContext s,
 Object subObj)

fromJson

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

use fromJsonToObject(GuiMappingContext, Object, Object)

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 - the source JSON

Returns:

the target or newly created object

fromJsonToObject

public static Object fromJsonToObject(GuiMappingContext context,
 Object target,
 Object json)

constructing an object or setting up the target object from the JSON. to set properties, it relies on GuiMappingContext.execute(Callable).

Parameters:

context - the context of the caller's repr

target - the target object, may be null, and then it creates a new object by 0-args constructor of the value type of the representation (supposing GuiReprValue)

json - the JSON object

Returns:

the target or newly created object

getReprValue

public static GuiReprValue getReprValue(GuiRepresentation repr)

toHumanReadableStringTree

public GuiRepresentation.TreeString toHumanReadableStringTree(GuiMappingContext context,
 Object source)

use toHumanReadableStringFromObject(GuiMappingContext, Object)

Parameters:

context - the context of the repr.

source - converted to string

Returns:

the representation of the source

toHumanReadableStringFromObject

public static String toHumanReadableStringFromObject(GuiMappingContext context,
 Object source)

constructing a human-readable string representation of the object. the contents consist of members of the object (listed by the context). each of them is processed by runSubPropertyValue(GuiMappingContext, Object, BiConsumer) if it is a property. For obtaining the value of the property, it relies on GuiMappingContext.execute(Callable). if it is a collection element, then it will be processed by runSubCollectionValue(GuiMappingContext, Object, BiConsumer).

Parameters:

context - the context associated with the caller's repr

source - the source object

Returns:

the representation of the source

toHumanReadableStringTreeFromObject

public static GuiRepresentation.TreeString toHumanReadableStringTreeFromObject(GuiMappingContext context,
 Object source)

called from toHumanReadableStringFromObject(GuiMappingContext, Object)

Parameters:

context - the object context

source - the source object mapped by the context

Returns:

a tree-string of source

Since:

1.8

getAddingHumanReadableStringToList

public static BiConsumer<GuiMappingContext,Object> getAddingHumanReadableStringToList(List<GuiRepresentation.TreeString> list)

runSubPropertyValue

public static void runSubPropertyValue(GuiMappingContext subContext,
 Object source,
 BiConsumer<GuiMappingContext,Object> subAndNext)

runSubCollectionValue

public static void runSubCollectionValue(GuiMappingContext subContext,
 Object source,
 BiConsumer<GuiMappingContext,Object> subAndNext)

fromHumanReadableString

public Object fromHumanReadableString(GuiMappingContext context,
 String str)

fromHumanReadableStringToObject

public static Object fromHumanReadableStringToObject(GuiMappingContext context,
 String str)

shutdown

public void shutdown(GuiMappingContext context,
 Object source)

Description copied from interface: GuiRepresentation

do shutting-down process if the target object is an AutoCloseable.

Parameters:

context - the context of the repr.

source - the target object, obtained from source value of the context

toString

public String toString()

Overrides:

toString in class GuiReprValue