to.etc.domui.component.image

Class ImageSelectControl

java.lang.Object

to.etc.domui.dom.css.CssBase

to.etc.domui.dom.html.NodeBase

to.etc.domui.dom.html.NodeContainer

to.etc.domui.dom.html.Div

to.etc.domui.component.image.ImageSelectControl

All Implemented Interfaces:

Iterable<NodeBase>, IUploadAcceptingComponent, INodeErrorDelegate, IActionControl, IControl<IUIImage>, IHasChangeListener, IDraggable, IDropBody, IDropTargetable

public class ImageSelectControl
extends Div
implements IUploadAcceptingComponent, IControl<IUIImage>

This control allows selecting a single image as an upload. The image is stored in VpBlob. The uploaded image is resized to a max. size which can be specified and shown as a thumbnail of (max) 32x32. All images are saved as png.

Author:

Frits Jalvingh Created on Nov 5, 2014

Constructor Summary

Constructors

Constructor and Description
ImageSelectControl()
ImageSelectControl(IUIImage value)

Method Summary

Modifier and Type	Method and Description
void	componentHandleWebDataRequest(RequestContextImpl ctx, String action) Called to render the image inside the component.
void	createContent()
Dimension	getDisplayDimensions()
String	getEmptyIcon() If you want to show another image then the "empty.png" image that is default shown when no image is available.
Dimension	getMaxDimensions()
IValueChanged<?>	getOnValueChanged()
IUIImage	getValue() Returns the current value of this input component.
IUIImage	getValueSafe() Like IControl.getValue() this returns the value of the component, but this returns null if the value was invalid.
boolean	handleUploadRequest(RequestContextImpl param, ConversationContext conversation)
boolean	isDisabled() Returns T if the control is currently in disabled.
boolean	isMandatory() Returns T if this control is a mandatory input.
boolean	isReadOnly() Returns T if the control is currently in readonly mode.
void	setDisabled(boolean disabled) Set the input to disabled mode.
void	setDisplayDimensions(Dimension displayDimensions)
void	setEmptyIcon(Class<?> base, String resurl) Set the source as a Java resource based off the given class.
void	setEmptyIcon(String src) Set the source for the image to show, if no image is given, as an absolute web app path.
void	setMandatory(boolean ro) Make the control mandatory.
void	setMaxDimensions(Dimension maxDimensions)
void	setOnValueChanged(IValueChanged<?> onValueChanged)
void	setReadOnly(boolean ro) Sets the input to readonly-mode.
void	setValue(IUIImage value) Set a new value into this control.

Methods inherited from class to.etc.domui.dom.html.Div

afterCreateContent, componentHandleWebAction, fadeIn, fadeOut, getCustomUpdatesCallJS, getDragHandler, getDropBody, getDropHandler, getDropMode, getReturnPressed, setDragHandler, setDropBody, setDropHandler, setReturnPressed, slideDown, slideUp, tb, visit

Methods inherited from class to.etc.domui.dom.html.NodeContainer

add, add, add, addTable, addTableForLayout, addTableForLayout, appendTreeErrors, canContain, createFrame, delegateTo, disableAllChildControlsDeep, findChildIndex, forceRebuild, getChild, getChildCount, getChildren, getDeepChildren, getDelegate, getErrorFence, getTextContents, hasError, internalAdd, internalCheckNotDirty, internalClearDelta, internalClearDeltaFully, internalCreateFrame, internalGetNodeCount, internalGetOldChildren, internalOnBeforeRender, internalShelve, internalUnshelve, iterator, onRefresh, removeAllChildren, removeChild, removeChild, replaceChild, setErrorFence, setErrorFence, setText, setValue, undelegatedAdd, undelegatedGetChild

Methods inherited from class to.etc.domui.dom.html.NodeBase

$, acceptRequestParameter, addBinding, addCssClass, addGlobalMessage, addNotificationListener, alignToLeft, alignToLeft, alignToMiddle, alignToMiddle, alignTopToBottom, alignTopToBottom, alignToRight, alignToRight, alignToTop, alignToTop, appendAfterMe, appendBeforeMe, appendCreateJS, appendJavascript, appendJQuerySelector, appendJsCustomUpdatesContributor, appendShowOverflowTextAsTitleJs, appendStatement, beforeCreateContent, bind, bind, bindErrors, build, calcTestID, changed, changedJavascriptState, clearFocusRequested, clearGlobalMessage, clearGlobalMessage, clearGlobalMessage, clearMessage, clearValidationFailure, createStatement, findComponentBundle, findParent, getActualID, getAllocationTracepoint, getBindingErrors, getBindingList, getBrowserWindowSize, getCalculatedTestID, getClicked, getClientBounds, getComponentBundle, getComponentDataURL, getComponentDataURL, getComponentInfo, getComponentJSONURL, getCreateJS, getCssClass, getErrorList, getErrorLocation, getFocusID, getMessage, getOnClickJS, getOnMouseDownJS, getOnSizeAndPositionChange, getPage, getParent, getParent, getParent, getParentOfTypes, getSharedContext, getSharedContextFactory, getSpecialAttribute, getSpecialAttributeList, getTag, getTestID, getTestRepeatId, getThemedResourceRURL, getTitle, getUserObject, handleDrop, hasCssClass, hasParent, internalGetOldParent, internalGetParent, internalHasChangedAttributes, internalNeedClickHandler, internalOnClicked, internalOnValueChanged, internalRenderJavascriptDelta, internalRenderJavascriptState, internalSetHasChangedAttributes, internalSetHasChangedAttributes, internalSetLogAllocations, internalSetTag, isAttached, isBuilt, isFocusable, isFocusRequested, isRendersOwnClose, isStretchHeight, lc, notify, notifyParentOrOpenerPage, onAddedToPage, onBeforeFullRender, onBeforeRender, onForceRebuild, onHeaderContributors, onRemoveFromPage, onShelve, onUnshelve, refresh, remove, removeBinding, removeCssClass, renderJavascriptDelta, renderJavascriptState, renderJavascriptState, replaceWith, setBrowserWindowSize, setCalculcatedId, setCalculcatedId, setClicked, setClientBounds, setComponentBundle, setCssClass, setErrorLocation, setFocus, setMessage, setOnClickJS, setOnMouseDownJS, setOnSizeAndPositionChange, setOverrideTitle, setSpecialAttribute, setStretchHeight, setTestID, setTestRepeatID, setTitle, setUserObject, toString

Methods inherited from class to.etc.domui.dom.css.CssBase

getBackgroundAttachment, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorderBottomColor, getBorderBottomStyle, getBorderBottomWidth, getBorderLeftColor, getBorderLeftStyle, getBorderLeftWidth, getBorderRightColor, getBorderRightStyle, getBorderRightWidth, getBorderTopColor, getBorderTopStyle, getBorderTopWidth, getBottom, getCachedStyle, getClear, getColor, getDisplay, getFloat, getFontFamily, getFontSize, getFontSizeAdjust, getFontStyle, getFontVariant, getFontWeight, getHeight, getLeft, getLineHeight, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOverflow, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPosition, getRight, getTextAlign, getTop, getTransform, getVerticalAlign, getVisibility, getWidth, getZIndex, internalSetDisplay, setBackgroundAttachment, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorder, setBorderBottomColor, setBorderBottomStyle, setBorderBottomWidth, setBorderColor, setBorderLeftColor, setBorderLeftStyle, setBorderLeftWidth, setBorderRightColor, setBorderRightStyle, setBorderRightWidth, setBorderStyle, setBorderTopColor, setBorderTopStyle, setBorderTopWidth, setBorderWidth, setBottom, setBottom, setCachedStyle, setClear, setColor, setDisplay, setFloat, setFontFamily, setFontSize, setFontSizeAdjust, setFontStyle, setFontVariant, setFontWeight, setHeight, setLeft, setLeft, setLineHeight, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setOverflow, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPosition, setRight, setRight, setTextAlign, setTop, setTop, setTransform, setVerticalAlign, setVisibility, setWidth, setZIndex

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface to.etc.domui.dom.html.IControl

getErrorLocation, hasError, setErrorLocation

Methods inherited from interface to.etc.domui.dom.html.IActionControl

setTestID

Methods inherited from interface to.etc.domui.dom.errors.INodeErrorDelegate

clearMessage, getMessage, setMessage

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ImageSelectControl

public ImageSelectControl(@Nullable
                          IUIImage value)

ImageSelectControl

public ImageSelectControl()

Method Detail

createContent

public void createContent()
                   throws Exception

Overrides:

createContent in class NodeBase

Throws:

Exception

componentHandleWebDataRequest

public void componentHandleWebDataRequest(RequestContextImpl ctx,
                                          String action)
                                   throws Exception

Called to render the image inside the component.

Overrides:

componentHandleWebDataRequest in class NodeBase

Throws:

Exception

See Also:

NodeBase.componentHandleWebDataRequest(to.etc.domui.server.RequestContextImpl, java.lang.String)

handleUploadRequest

public boolean handleUploadRequest(RequestContextImpl param,
                                   ConversationContext conversation)
                            throws Exception

Specified by:

handleUploadRequest in interface IUploadAcceptingComponent

Throws:

Exception

getDisplayDimensions

@Nonnull
public Dimension getDisplayDimensions()

setDisplayDimensions

public void setDisplayDimensions(@Nonnull
                                 Dimension displayDimensions)

getMaxDimensions

@Nonnull
public Dimension getMaxDimensions()

setMaxDimensions

public void setMaxDimensions(@Nonnull
                             Dimension maxDimensions)

getValue

@Nullable
public IUIImage getValue()

Description copied from interface: IControl

Returns the current value of this input component. If the component contains no value this returns null. All text input components will return null when their value is the empty string! If the component, during conversion or validation of the input value, discovers that the input is invalid it will set itself in "error" mode, post an error message up the form, and throw a ValidationException. This means that this call either delivers correct input (as defined by it's converter and validators), null (when empty) or throws an exception. When a ValidationException occurs the framework mostly ignores it - it does not produce a stacktrace or error in the client. Instead the resulting error as posted by the error handling framework gets displayed on the form when the request completes.

To get the value of a component while ignoring exceptions call IControl.getValueSafe().

Specified by:

getValue in interface IControl<IUIImage>

Returns:

setValue

public void setValue(@Nullable
                     IUIImage value)

Description copied from interface: IControl

Set a new value into this control. Setting a value to null means the control holds no value. This value is converted to a presentable form using any (implicitly) defined converters; it will not be validated though! This means that if you set an invalid value for a validator this will not be seen until the value is gotten from the control again.

Specified by:

setValue in interface IControl<IUIImage>

getOnValueChanged

public IValueChanged<?> getOnValueChanged()

Specified by:

getOnValueChanged in interface IHasChangeListener

setOnValueChanged

public void setOnValueChanged(IValueChanged<?> onValueChanged)

Specified by:

setOnValueChanged in interface IHasChangeListener

getValueSafe

public IUIImage getValueSafe()

Description copied from interface: IControl

Like IControl.getValue() this returns the value of the component, but this returns null if the value was invalid. For this method NULL either means the value was invalid OR it's content was empty. To distinguish between the two call IControl.hasError() or use IControl.getValue() instead of this call.

Specified by:

getValueSafe in interface IControl<IUIImage>

Returns:

isReadOnly

public boolean isReadOnly()

Description copied from interface: IControl

Returns T if the control is currently in readonly mode. Controls that do not have a readonly ability (comboboxes) will use disabled as the readonly state. For those controls the readonly state mirrors the disabled state.

Specified by:

isReadOnly in interface IControl<IUIImage>

Returns:

setReadOnly

public void setReadOnly(boolean ro)

Description copied from interface: IControl

Sets the input to readonly-mode. Components that do not implement readonly mode (comboboxes) will usually set themselves to disabled which works much the same.

Specified by:

setReadOnly in interface IControl<IUIImage>

isMandatory

public boolean isMandatory()

Description copied from interface: IControl

Returns T if this control is a mandatory input.

Specified by:

isMandatory in interface IControl<IUIImage>

Returns:

setMandatory

public void setMandatory(boolean ro)

Description copied from interface: IControl

Make the control mandatory.

Specified by:

setMandatory in interface IControl<IUIImage>

isDisabled

public boolean isDisabled()

Description copied from interface: IControl

Returns T if the control is currently in disabled. Controls that do not have a readonly ability (comboboxes) will use disabled as the readonly state. For those controls the readonly state mirrors the disabled state.

Specified by:

isDisabled in interface IControl<IUIImage>

Returns:

setDisabled

public void setDisabled(boolean disabled)

Description copied from interface: IActionControl

Set the input to disabled mode.

Specified by:

setDisabled in interface IActionControl

getEmptyIcon

@Nullable
public String getEmptyIcon()

If you want to show another image then the "empty.png" image that is default shown when no image is available.

Returns:

setEmptyIcon

public void setEmptyIcon(@Nonnull
                         String src)

Set the source for the image to show, if no image is given, as an absolute web app path. If the name is prefixed with THEME/ it specifies an image from the current THEME's directory.

Parameters:

src -

setEmptyIcon

public void setEmptyIcon(@Nonnull
                         Class<?> base,
                         @Nonnull
                         String resurl)

Set the source as a Java resource based off the given class.

Parameters:

base -

resurl -