io.jmix.ui.component

Interface Image<T>

All Superinterfaces:

Component, Component.HasCaption, Component.HasDescription, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, HasValueSource<T>, ResourceView

All Known Implementing Classes:

ImageImpl

@StudioComponent(caption="Image",
                 category="Components",
                 xmlElement="image",
                 icon="io/jmix/ui/icon/component/image.svg",
                 canvasIconSize=LARGE,
                 documentationURL="https://docs.jmix.io/jmix/%VERSION%/backoffice-ui/vcl/components/image.html")
public interface Image<T>
extends ResourceView, HasValueSource<T>

The Image component is intended for displaying graphic content.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Image.ClickEvent A Image.ClickEvent is fired when the user clicks on an Image.
static class	Image.ScaleMode Defines image scale mode.

Nested classes/interfaces inherited from interface io.jmix.ui.component.ResourceView

ResourceView.HasMimeType, ResourceView.HasStreamSettings, ResourceView.SourceChangeEvent

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method and Description
io.jmix.core.common.event.Subscription	addClickListener(java.util.function.Consumer<Image.ClickEvent> listener)
Image.ScaleMode	getScaleMode()
void	removeClickListener(java.util.function.Consumer<Image.ClickEvent> listener) Deprecated. Use Subscription instead
default void	reset() Resets the component source and disposes of the corresponding resource.
void	setScaleMode(Image.ScaleMode scaleMode) Applies the given scale mode to the image.

Methods inherited from interface io.jmix.ui.component.ResourceView

addSourceChangeListener, getAlternateText, getSource, setAlternateText, setSource, setSource

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface io.jmix.ui.component.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface io.jmix.ui.component.Component.HasCaption

getCaption, setCaption

Methods inherited from interface io.jmix.ui.component.Component.HasDescription

getDescription, setDescription

Methods inherited from interface io.jmix.ui.component.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface io.jmix.ui.component.HasHtmlSanitizer

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Methods inherited from interface io.jmix.ui.component.data.HasValueSource

getValueSource, setValueSource

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

reset

default void reset()

Resets the component source and disposes of the corresponding resource.

getScaleMode

Image.ScaleMode getScaleMode()

Returns:

image scale mode

setScaleMode

@StudioProperty(type=ENUMERATION,
                defaultValue="NONE",
                options={"NONE","FILL","CONTAIN","COVER","SCALE_MODE"})
void setScaleMode(Image.ScaleMode scaleMode)

Applies the given scale mode to the image.

Parameters:

scaleMode - scale mode

addClickListener

io.jmix.core.common.event.Subscription addClickListener(java.util.function.Consumer<Image.ClickEvent> listener)

removeClickListener

void removeClickListener(java.util.function.Consumer<Image.ClickEvent> listener)

Deprecated. Use Subscription instead

Parameters:

listener - a listener to remove