Module org.autogui

Package org.autogui.base.mapping

Class GuiReprValueEnumComboBox

java.lang.Object

org.autogui.base.mapping.GuiReprValue

org.autogui.base.mapping.GuiReprValueEnumComboBox

All Implemented Interfaces:

GuiRepresentation

public class GuiReprValueEnumComboBox
extends GuiReprValue

a combo-box component for an Enum property

      @GuiIncluded public EnumVal prop;

      public enum EnumVal {...}
  

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 Pattern	numPattern

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

NONE, NONE_WITH_CACHE

Constructor Summary

Constructors

Constructor	Description
GuiReprValueEnumComboBox()

Method Summary

Modifier and Type	Method	Description
Object	fromHumanReadableString(GuiMappingContext context, String str)	same as fromJson(GuiMappingContext, Object, Object)
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.
String	getDisplayName(GuiMappingContext context, Enum<?> enumValue)
Object[]	getEnumConstants(GuiMappingContext context)
Object	getEnumValue(GuiMappingContext context, String nameOrIndex)
boolean	isJsonSetter()
boolean	matchValueType(Class<?> cls)
GuiRepresentation.TreeString	toHumanReadableStringTree(GuiMappingContext context, Object source)	same as toJson(GuiMappingContext, Object)
Object	toJson(GuiMappingContext context, Object source)	convert the source into JSON format

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

Field Details

numPattern

protected Pattern numPattern

Constructor Details

GuiReprValueEnumComboBox

public GuiReprValueEnumComboBox()

Method Details

matchValueType

public boolean matchValueType(Class<?> cls)

Overrides:

matchValueType in class GuiReprValue

getDisplayName

public String getDisplayName(GuiMappingContext context,
 Enum<?> enumValue)

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:

a name of a Enum member

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 context of the repr.

target - unused

json - a String as a name of a member of an enum.

Returns:

an Enum member of the name

toHumanReadableStringTree

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

same as toJson(GuiMappingContext, Object)

Parameters:

context - the context of the repr.

source - converted to string

Returns:

a name of a Enum member

fromHumanReadableString

public Object fromHumanReadableString(GuiMappingContext context,
 String str)

same as fromJson(GuiMappingContext, Object, Object)

Parameters:

context - the context of the repr.

str - the source str: name of a member

Returns:

an Enum member of the name

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

getEnumConstants

public Object[] getEnumConstants(GuiMappingContext context)

getEnumValue

public Object getEnumValue(GuiMappingContext context,
 String nameOrIndex)

Parameters:

context - the context which is used for obtaining the type of the enum.

nameOrIndex - Enum.name() or Enum.ordinal()

Returns:

an Enum member or null if not found