Module org.autogui

Package org.autogui.base.mapping

Class GuiReprValueFilePathField

java.lang.Object

org.autogui.base.mapping.GuiReprValue

org.autogui.base.mapping.GuiReprValueFilePathField

All Implemented Interfaces:

GuiRepresentation

public class GuiReprValueFilePathField
extends GuiReprValue

a text-field component for a File or Path property.

     @GuiIncluded public Path propPath;
     @GuiIncluded public File propFile;
 

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 inherited from class org.autogui.base.mapping.GuiReprValue

NONE, NONE_WITH_CACHE

Constructor Summary

Constructors

Constructor	Description
GuiReprValueFilePathField()

Method Summary

Modifier and Type	Method	Description
void	addHistoryValue(GuiMappingContext context, Object value)
Object	fromHumanReadableString(GuiMappingContext context, String str)	same as fromJson(GuiMappingContext, Object, Object)
Object	fromJson(GuiMappingContext context, Object target, Object json)	obtain a file-path object from the string json
boolean	isJsonSetter()
boolean	matchValueType(Class<?> cls)
void	setSource(GuiMappingContext context, Object value)
String	toHumanReadableString(GuiMappingContext context, Object source)	same as toJson(GuiMappingContext, Object)
Object	toJson(GuiMappingContext context, Object source)	convert the source into JSON format
Path	toUpdateValue(GuiMappingContext context, Object value)	called from a GUI element in order to update its value.
Object	toValueFromPath(GuiMappingContext context, Path path)
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.
Object	updateCollectionElement(GuiMappingContext context, GuiMappingContext.GuiSourceValue collection, Object newValue, GuiReprValue.ObjectSpecifier elementSpecifier)	a table pane updates a specified element
void	updateFromGui(GuiMappingContext context, Object newValue, GuiReprValue.ObjectSpecifier specifier, GuiTaskClock viewClock)	call the setter by editing on GUI, and GuiMappingContext.updateSourceFromGui(Object).
Object	updateWithParentSource(GuiMappingContext context, Object newValue, GuiReprValue.ObjectSpecifier specifier)	obtain the parent source by GuiReprValue.getUpdatedSource(GuiMappingContext, GuiReprValue.ObjectSpecifier) and call GuiReprValue.update(GuiMappingContext, GuiMappingContext.GuiSourceValue, Object, GuiReprValue.ObjectSpecifier)

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

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

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, isTaskRunnerUsedFor, matchAndSetNotifiersAsInit, setNotifiersTree, shutdown, toJsonWithNamed, toStringHeader

Constructor Details

GuiReprValueFilePathField

public GuiReprValueFilePathField()

Method Details

matchValueType

public boolean matchValueType(Class<?> cls)

Overrides:

matchValueType in class GuiReprValue

toValueFromPath

public Object toValueFromPath(GuiMappingContext context,
 Path path)

updateFromGui

public void updateFromGui(GuiMappingContext context,
 Object newValue,
 GuiReprValue.ObjectSpecifier specifier,
 GuiTaskClock viewClock)

Description copied from class: GuiReprValue

call the setter by editing on GUI, and GuiMappingContext.updateSourceFromGui(Object).

• add newValue to the history by GuiReprValue.addHistoryValue(GuiMappingContext, Object)
• obtain parent source and update GuiReprValue.updateWithParentSource(GuiMappingContext, Object, ObjectSpecifier)
• check GuiReprValue.isUpdateContextSourceByUpdateFromGui(GuiMappingContext) and GuiMappingContext.updateSourceFromGui(Object): update the source and notify to listeners

Overrides:

updateFromGui in class GuiReprValue

Parameters:

context - the context of this repr.

newValue - the updated property value

specifier - the specifier of the value

viewClock - the clock value of sender view

updateCollectionElement

public Object updateCollectionElement(GuiMappingContext context,
 GuiMappingContext.GuiSourceValue collection,
 Object newValue,
 GuiReprValue.ObjectSpecifier elementSpecifier)
                               throws Throwable

Description copied from class: GuiReprValue

a table pane updates a specified element

Overrides:

updateCollectionElement in class GuiReprValue

Parameters:

context - the context of the repr

collection - a collection target

newValue - an element value

elementSpecifier - an element index i.e. GuiReprValue.ObjectSpecifierIndex

Returns:

the updated value

Throws:

Throwable - an error while updating

updateWithParentSource

public Object updateWithParentSource(GuiMappingContext context,
 Object newValue,
 GuiReprValue.ObjectSpecifier specifier)
                              throws Throwable

Description copied from class: GuiReprValue

obtain the parent source by GuiReprValue.getUpdatedSource(GuiMappingContext, GuiReprValue.ObjectSpecifier) and call GuiReprValue.update(GuiMappingContext, GuiMappingContext.GuiSourceValue, Object, GuiReprValue.ObjectSpecifier)

Overrides:

updateWithParentSource in class GuiReprValue

Parameters:

context - the target context

newValue - a new value to be set to the property

specifier - the specifier of the value

Returns:

the returned value by updating

Throws:

Throwable - an error while getParentSource or update

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

addHistoryValue

public void addHistoryValue(GuiMappingContext context,
 Object value)

Overrides:

addHistoryValue in class GuiReprValue

setSource

public void setSource(GuiMappingContext context,
 Object value)

Overrides:

setSource in class GuiReprValue

toUpdateValue

public Path 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

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:

path String

fromJson

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

obtain a file-path object from the string json

Specified by:

fromJson in interface GuiRepresentation

Overrides:

fromJson in class GuiReprValue

Parameters:

context - the context of the repr.

target - unused

json - suppose a String

Returns:

Path or File (determined by the context type), 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)

same as toJson(GuiMappingContext, Object)

Parameters:

context - the context of the repr.

source - converted to string

Returns:

a path string

fromHumanReadableString

public Object fromHumanReadableString(GuiMappingContext context,
 String str)

same as fromJson(GuiMappingContext, Object, Object)

Parameters:

context - the context of the repr

str - a path string

Returns:

Path or File