Module org.autogui

Package org.autogui.base.mapping

Class GuiReprValueBooleanCheckBox

java.lang.Object

org.autogui.base.mapping.GuiReprValue

org.autogui.base.mapping.GuiReprValueBooleanCheckBox

All Implemented Interfaces:

GuiRepresentation

public class GuiReprValueBooleanCheckBox
extends GuiReprValue

an abstract checkbox component for a Boolean or primitive boolean property

      @GuiIncluded public boolean prop;
  

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

NONE, NONE_WITH_CACHE

Constructor Summary

Constructors

Constructor	Description
GuiReprValueBooleanCheckBox()

Method Summary

Modifier and Type	Method	Description
Object	fromHumanReadableString(GuiMappingContext context, String str)	use getBooleanValue(String)
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.
Boolean	getBooleanValue(String data)
boolean	isJsonSetter()
boolean	matchValueType(Class<?> cls)
GuiRepresentation.TreeString	toHumanReadableStringTree(GuiMappingContext context, Object source)
Object	toJson(GuiMappingContext context, Object source)	convert the source into JSON format
Boolean	toUpdateValue(GuiMappingContext context, Object newValue)	called from a GUI element in order to update its value.

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, isHistoryValueStored, isHistoryValueSupported, isHistoryValueSupported, isUpdateContextSourceByUpdateFromGui, match, notifyUpdateWithParentSourceNone, setSource, toParentSource, toSource, toString, 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, isTaskRunnerUsedFor, matchAndSetNotifiersAsInit, setNotifiersTree, shutdown, toHumanReadableString, toJsonWithNamed, toStringHeader

Constructor Details

GuiReprValueBooleanCheckBox

public GuiReprValueBooleanCheckBox()

Method Details

matchValueType

public boolean matchValueType(Class<?> cls)

Overrides:

matchValueType in class GuiReprValue

toUpdateValue

public Boolean toUpdateValue(GuiMappingContext context,
 Object newValue)

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.

newValue - 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:

Boolean

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.

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)

use getBooleanValue(String)

Parameters:

context - the context (ignored)

str - the source string

Returns:

a Boolean value

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

getBooleanValue

public Boolean getBooleanValue(String data)

Parameters:

data - a source string

Returns:

false for "false" or "0". true for "true" or digits. case insensitive. null for null