Module org.autogui

Package org.autogui.base.mapping

Class GuiReprPropertyPane

java.lang.Object

org.autogui.base.mapping.GuiReprValue

org.autogui.base.mapping.GuiReprPropertyPane

All Implemented Interfaces:

GuiRepresentation

public class GuiReprPropertyPane
extends GuiReprValue

a property member definition: [propertyName: [ propertyValueField ] ].

the representation matches any context which has a property-member-type. However, value representations (string, file, enum, boolean and number) directly support the property-member-type and precedes this representation.

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	subRepresentations

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

NONE, NONE_WITH_CACHE

Constructor Summary

Constructors

Constructor	Description
GuiReprPropertyPane()
GuiReprPropertyPane(GuiRepresentation subRepresentations)

Method Summary

Modifier and Type	Method	Description
GuiReprPropertyPane	createForContext(GuiMappingContext context)
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	fromJsonProperty(GuiMappingContext context, Object target, Object json)
Object	fromJsonWithNamed(GuiMappingContext context, Object target, Object json)
Object	fromSource(Object o)
GuiRepresentation	getSubRepresentations()
boolean	isEditableFromChild(GuiMappingContext context)
boolean	isFromJsonTakingMapWithContextNameEntry(GuiMappingContext context)
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 *
void	setSubRepresentations(GuiRepresentation subRepresentations)
GuiRepresentation.TreeString	toHumanReadableStringTree(GuiMappingContext context, Object source)
Object	toJson(GuiMappingContext context, Object source)	convert the source into JSON format
Object	toJsonProperty(GuiMappingContext context, Object source)
Object	toJsonWithNamed(GuiMappingContext context, Object source)	the source might be a GuiReprValue.NamedValue, then it unwraps the named value, calls GuiRepresentation.toJson(GuiMappingContext, Object), and it returns Map with the name.
Object	toSource(Object o)
String	toString()

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

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

Field Details

subRepresentations

protected GuiRepresentation subRepresentations

Constructor Details

GuiReprPropertyPane

public GuiReprPropertyPane(GuiRepresentation subRepresentations)

GuiReprPropertyPane

public GuiReprPropertyPane()

Method Details

setSubRepresentations

public void setSubRepresentations(GuiRepresentation subRepresentations)

getSubRepresentations

public GuiRepresentation getSubRepresentations()

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

toSource

public Object toSource(Object o)

Overrides:

toSource in class GuiReprValue

Parameters:

o - a wrapped object for clients of the representation

Returns:

a raw-object which can be directly passed to type-element's executing methods

fromSource

public Object fromSource(Object o)

Overrides:

fromSource in class GuiReprValue

Parameters:

o - a raw-object which can be directly passed to type-element's executing methods

Returns:

a wrapped object for clients of the representation

createForContext

public GuiReprPropertyPane createForContext(GuiMappingContext context)

isEditableFromChild

public boolean isEditableFromChild(GuiMappingContext context)

toJsonWithNamed

public Object toJsonWithNamed(GuiMappingContext context,
 Object source)

Description copied from interface: GuiRepresentation

the source might be a GuiReprValue.NamedValue, then it unwraps the named value, calls GuiRepresentation.toJson(GuiMappingContext, Object), and it returns Map with the name. otherwise, it simply calls toJson and returns the result.

Parameters:

context - context of the repr.

source - the source of returned JSON

Returns:

JSON object

fromJsonWithNamed

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

Parameters:

context - the context of the repr. In most cases, the type of the context will be a property.

target - the target object. if it is GuiReprValue.NamedValue, then it obtains the value. nullable

json - a Map with containing an entry for the name of the context

Returns:

the returned value GuiRepresentation.fromJson(GuiMappingContext, Object, Object). if the target is a NamedValue, the returned value will also be a NamedValue.

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:

Map: { propertyName: propertyJson, ... }

toJsonProperty

public Object toJsonProperty(GuiMappingContext context,
 Object source)

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 - the target context

target - the target value, which might be a GuiReprValue.NamedValue or the value of the property. Note: the target is not a property owner object.

json - a Map json

Returns:

the property value or a GuiReprValue.NamedValue if the target is also the one.

fromJsonProperty

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

isFromJsonTakingMapWithContextNameEntry

public boolean isFromJsonTakingMapWithContextNameEntry(GuiMappingContext context)

Overrides:

isFromJsonTakingMapWithContextNameEntry in class GuiReprValue

Parameters:

context - the target context

Returns:

true means GuiReprValue.fromJson(GuiMappingContext, Object, Object) takes a map with the entry named GuiMappingContext.getName()

toHumanReadableStringTree

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

Parameters:

context - the context of the repr

source - convert to string

Returns:

tree string of source, can be encoded by Object.toString() (used by GuiRepresentation.toHumanReadableString(GuiMappingContext, Object)

fromHumanReadableString

public Object fromHumanReadableString(GuiMappingContext context,
 String str)

isHistoryValueSupported

public boolean isHistoryValueSupported()

Overrides:

isHistoryValueSupported in class GuiReprValue

Returns:

false: a property does not support history values, but the content repr. might support it.

toString

public String toString()

Overrides:

toString in class GuiReprValue