Module org.autogui

Package org.autogui.base.mapping

Class GuiReprCollectionElement

java.lang.Object

org.autogui.base.mapping.GuiReprValue

org.autogui.base.mapping.GuiReprCollectionElement

All Implemented Interfaces:

GuiRepresentation

public class GuiReprCollectionElement
extends GuiReprValue

elements in a collection table GuiReprCollectionTable.

value obtaining and updating in this class are intended to operate an element in a collection.

• the class overrides getValue(GuiMappingContext, GuiMappingContext.GuiSourceValue, ObjectSpecifier, GuiMappingContext.GuiSourceValue) and update(GuiMappingContext, GuiMappingContext.GuiSourceValue, Object, ObjectSpecifier).
• Those methods delegate to the parent GuiReprCollectionTable's collection methods (i.e. GuiReprValue.getValueCollectionElement(GuiMappingContext, GuiMappingContext.GuiSourceValue, ObjectSpecifier, GuiMappingContext.GuiSourceValue), and GuiReprValue.updateCollectionElement(GuiMappingContext, GuiMappingContext.GuiSourceValue, Object, ObjectSpecifier)).
• Those methods take an indexed specifier (GuiReprValue.ObjectSpecifierIndex) for specifying an element in a collection.

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

Field Summary

Fields

Modifier and Type	Field	Description
protected GuiRepresentation	representation

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

NONE, NONE_WITH_CACHE

Constructor Summary

Constructors

Constructor	Description
GuiReprCollectionElement(GuiRepresentation representation)

Method Summary

Modifier and Type	Method	Description
boolean	checkAndUpdateSource(GuiMappingContext context)	nothing happen
boolean	continueCheckAndUpdateSourceForChildren(GuiMappingContext context, boolean parentUpdate)
GuiRepresentation	createElement(GuiRepresentation wrapped)
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.
GuiMappingContext	getElementChild(GuiMappingContext context)
int	getFixedColumnIndex(GuiMappingContext context, GuiMappingContext columnContext)
int	getFixedColumnSize(GuiMappingContext context)
GuiRepresentation	getRepresentation()
GuiUpdatedValue	getValue(GuiMappingContext context, GuiMappingContext.GuiSourceValue parentSource, GuiReprValue.ObjectSpecifier specifier, GuiMappingContext.GuiSourceValue prev)	obtain the property value from parentSource as an owner.
int	getValueCollectionSize(GuiMappingContext context, GuiMappingContext.GuiSourceValue collection, GuiReprValue.ObjectSpecifier specifier)	a table pane returns the size of a collection
Class<?>	getValueType(GuiMappingContext context)	obtains the value type from the context.
boolean	isHistoryValueSupported()
boolean	isJsonSetter()
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 *
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
String	toString()
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, convertLog, createNewValue, errorWhileAddHistoryValue, fromSource, fromSourceUpdated, getNoneSupplier, getParentSource, getUpdatedSource, getUpdatedValue, getUpdatedValueWithoutNoUpdate, getValueCollectionElement, getValueWithoutNoUpdate, isEditable, isFromJsonTakingMapWithContextNameEntry, isHistoryValueStored, isHistoryValueStored, isHistoryValueSupported, isUpdateContextSourceByUpdateFromGui, matchValueType, notifyUpdateWithParentSourceNone, setSource, toParentSource, toSource, toUpdateValue, 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

fromJsonWithNamed, isTaskRunnerUsedFor, matchAndSetNotifiersAsInit, setNotifiersTree, shutdown, toJsonWithNamed, toStringHeader

Field Details

representation

protected GuiRepresentation representation

Constructor Details

GuiReprCollectionElement

public GuiReprCollectionElement(GuiRepresentation representation)

Method Details

getRepresentation

public GuiRepresentation getRepresentation()

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

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.

createElement

public GuiRepresentation createElement(GuiRepresentation wrapped)

getElementChild

public GuiMappingContext getElementChild(GuiMappingContext context)

Parameters:

context - the target context

Returns:

the child context whose repr is the wrapped representation of the element

checkAndUpdateSource

public boolean checkAndUpdateSource(GuiMappingContext context)

nothing happen

Specified by:

checkAndUpdateSource in interface GuiRepresentation

Overrides:

checkAndUpdateSource in class GuiReprValue

Parameters:

context - the context of the repr.

Returns:

always false

continueCheckAndUpdateSourceForChildren

public boolean continueCheckAndUpdateSourceForChildren(GuiMappingContext context,
 boolean parentUpdate)

Parameters:

context - the context of the repr.

parentUpdate - ignored

Returns:

always false

getValueType

public Class<?> getValueType(GuiMappingContext context)

Description copied from class: GuiReprValue

obtains the value type from the context. the implementation checks the context is a property, or an element value

Overrides:

getValueType in class GuiReprValue

Parameters:

context - the context

Returns:

a property type class, an element value class, or null

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.

getValueCollectionSize

public int getValueCollectionSize(GuiMappingContext context,
 GuiMappingContext.GuiSourceValue collection,
 GuiReprValue.ObjectSpecifier specifier)
                           throws Throwable

Description copied from class: GuiReprValue

a table pane returns the size of a collection

Overrides:

getValueCollectionSize in class GuiReprValue

Parameters:

context - the context of the repr

collection - a collection target

specifier - the specifier of the collection

Returns:

the size of the collection, default is 1

Throws:

Throwable - an error while getting

update

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

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

Throws:

Throwable - an error while updating

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:

List (ArrayList): [ elementJson, ... ]. Note: null elements are skipped.

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.

isJsonSetter

public boolean isJsonSetter()

Returns:

true means GuiRepresentation.fromJson(GuiMappingContext, Object, Object) takes a target object and set json properties to the target. otherwise, the method will return a new value, thus the target can be null

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)

getFixedColumnSize

public int getFixedColumnSize(GuiMappingContext context)

Parameters:

context - the context of the repr.

Returns:

the size of columns which is equivalent to the size of the children, or -1 which means that the number of columns might be dynamic.

getFixedColumnIndex

public int getFixedColumnIndex(GuiMappingContext context,
 GuiMappingContext columnContext)

toString

public String toString()

Overrides:

toString in class GuiReprValue