Module org.autogui

Package org.autogui.swing.mapping

Class GuiReprValueImagePane

java.lang.Object

org.autogui.base.mapping.GuiReprValue

org.autogui.swing.mapping.GuiReprValueImagePane

All Implemented Interfaces:

GuiRepresentation

public class GuiReprValueImagePane
extends GuiReprValue

a GUI representation for a property holding an Image. the representation depends on some AWT classes (java.desktop module)

      @GuiIncluded public Image imageProp;
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GuiReprValueImagePane.ImageHistoryEntry	a special value of history entry which has an image, and it's source file path
static class	GuiReprValueImagePane.ImageSizeGetter	an ImageObserver for obtaining the size of an image
static interface	GuiReprValueImagePane.RenderedImageGetterSupport	support object for getRenderedImage(GuiMappingContext, Object)
static class	GuiReprValueImagePane.RenderedImageGetterSupportForContext	impl of the support interface

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 Map<Image,Path>	imageToReference
protected static GuiReprValueImagePane	instance	the global instance set by GuiReprValueImagePane(boolean) with true

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

NONE, NONE_WITH_CACHE

Constructor Summary

Constructors

Constructor	Description
GuiReprValueImagePane()	the created instance will not be the global instance
GuiReprValueImagePane(boolean processGlobal)

Method Summary

Modifier and Type	Method	Description
void	addHistoryValue(GuiMappingContext context, Object value)
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.
BufferedImage	getBufferedImage(GuiMappingContext context, Object source)
static BufferedImage	getBufferedImageWithSupport(GuiReprValueImagePane.RenderedImageGetterSupport support, Object source)	impl.
Path	getImagePath(Image image)
static GuiReprValueImagePane	getInstance()	return the default global instance of the class, useful for getImagePath(Image).
RenderedImage	getRenderedImage(GuiMappingContext context, Object source)
static RenderedImage	getRenderedImageWithSupport(GuiReprValueImagePane.RenderedImageGetterSupport support, Object source)	impl.
Dimension	getSize(GuiMappingContext context, Image image)
boolean	isHistoryValueStored(Object value)	only images which have been setImagePath(Image, Path) will be stored as its path through GuiReprValueImagePane.ImageHistoryEntry.
boolean	isJsonSetter()
boolean	matchValueType(Class<?> cls)
void	setImagePath(Image image, Path path)
GuiRepresentation.TreeString	toHumanReadableStringTree(GuiMappingContext context, Object source)
Object	toJson(GuiMappingContext context, Object source)	convert the source into JSON format
void	updateFromGui(GuiMappingContext context, Object newValue, GuiReprValue.ObjectSpecifier specifier, GuiTaskClock clock)	call the setter by editing on GUI, and GuiMappingContext.updateSourceFromGui(Object).
Image	updateValue(GuiMappingContext context, Object value)

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, isHistoryValueSupported, isHistoryValueSupported, isUpdateContextSourceByUpdateFromGui, match, notifyUpdateWithParentSourceNone, setSource, toParentSource, toSource, toString, toUpdateValue, unwrapNoUpdate, update, updateCollectionElement, 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

imageToReference

protected Map<Image,Path> imageToReference

instance

protected static GuiReprValueImagePane instance

the global instance set by GuiReprValueImagePane(boolean) with true

Since:

1.1

Constructor Details

GuiReprValueImagePane

public GuiReprValueImagePane()

the created instance will not be the global instance

GuiReprValueImagePane

public GuiReprValueImagePane(boolean processGlobal)

Parameters:

processGlobal - if true, the instance will be held by the static field of the class, which can be obtained by getInstance(). This is useful for obtaining image paths

Since:

1.1

Method Details

getInstance

public static GuiReprValueImagePane getInstance()

return the default global instance of the class, useful for getImagePath(Image).

     void setImage(Image img) {
        ...
        Path p = GuiReprValueImagePane.getInstance().getImagePath(img);
        if (p != null) {
          ... //if the user drag an image file to the associated pane, p will be the path of the file.
        }
     }
 

Returns:

the global instance.

Since:

1.1

matchValueType

public boolean matchValueType(Class<?> cls)

Overrides:

matchValueType in class GuiReprValue

updateValue

public Image updateValue(GuiMappingContext context,
 Object value)

getSize

public Dimension getSize(GuiMappingContext context,
 Image image)

isHistoryValueStored

public boolean isHistoryValueStored(Object value)

only images which have been setImagePath(Image, Path) will be stored as its path through GuiReprValueImagePane.ImageHistoryEntry. Currently, GuiReprValueImagePane.ImageHistoryEntry will not appear to non-history related arguments (like update(...newValue...)

Overrides:

isHistoryValueStored in class GuiReprValue

Parameters:

value - GuiReprValueImagePane.ImageHistoryEntry or Image

Returns:

true only if GuiReprValueImagePane.ImageHistoryEntry or null (loading)

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 Image or GuiReprValueImagePane.ImageHistoryEntry

Returns:

image bytes encoded as PNG base64 String(data:image/png;base64,...), or source file path (file://...) if the source is a GuiReprValueImagePane.ImageHistoryEntry. The method does not check registered file paths by setImagePath(Image, Path). For non-RenderedImage, it temporally creates a BufferedImage and renders the source to the image.

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, ignored

target - the target object, ignored

json - a string with format of data:... or file://...

Returns:

an Image or an GuiReprValueImagePane.ImageHistoryEntry with lazy loading (at the loading, setImagePath(Image, Path) will be called and the path is stored).

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)

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

setImagePath

public void setImagePath(Image image,
 Path path)

getImagePath

public Path getImagePath(Image image)

getRenderedImageWithSupport

public static RenderedImage getRenderedImageWithSupport(GuiReprValueImagePane.RenderedImageGetterSupport support,
 Object source)

impl. of getRenderedImage(GuiMappingContext, Object)

Parameters:

support - the non-null support

source - the source image object

Returns:

source or if it is not an RenderedImage, it renders to a temporary buffered-image.

Since:

1.7

getBufferedImageWithSupport

public static BufferedImage getBufferedImageWithSupport(GuiReprValueImagePane.RenderedImageGetterSupport support,
 Object source)

impl. of getBufferedImage(GuiMappingContext, Object)

Parameters:

support - the non-null support

source - the source image object

Returns:

source or if it is not an RenderedImage, it renders to a temporary buffered-image.

Since:

1.7

getRenderedImage

public RenderedImage getRenderedImage(GuiMappingContext context,
 Object source)

getBufferedImage

public BufferedImage getBufferedImage(GuiMappingContext context,
 Object source)

updateFromGui

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

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

clock - the clock value of sender view

addHistoryValue

public void addHistoryValue(GuiMappingContext context,
 Object value)

Overrides:

addHistoryValue in class GuiReprValue