com.haulmont.cuba.gui.components

Interface Image

All Superinterfaces:

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

public interface Image
extends ResourceView, HasValueSource<FileDescriptor>

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 com.haulmont.cuba.gui.components.ResourceView

ResourceView.HasMimeType, ResourceView.HasStreamSettings, ResourceView.SourceChangeEvent

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

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

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

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

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
Subscription	addClickListener(java.util.function.Consumer<Image.ClickEvent> listener)
default Datasource	getDatasource() Deprecated. Use HasValueSource.getValueSource() instead.
default MetaPropertyPath	getMetaPropertyPath()
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.
default void	setDatasource(Datasource datasource, java.lang.String property) Deprecated. Use HasValueSource.setValueSource(ValueSource) instead.
void	setScaleMode(Image.ScaleMode scaleMode) Applies the given scale mode to the image.

Methods inherited from interface com.haulmont.cuba.gui.components.ResourceView

addSourceChangeListener, createResource, getAlternateText, getSource, removeSourceChangeListener, setAlternateText, setSource, setSource

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, getWidthUnits, isEnabled, isEnabledItself, isEnabledRecursive, isResponsive, isVisible, isVisibleItself, isVisibleRecursive, removeStyleName, requestFocus, 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 com.haulmont.cuba.gui.components.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasCaption

getCaption, setCaption

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasDescription

getDescription, setDescription

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlSanitizer

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Methods inherited from interface com.haulmont.cuba.gui.components.data.HasValueSource

getValueSource, setValueSource

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

setDatasource

@Deprecated
default void setDatasource(Datasource datasource,
                                       java.lang.String property)

Deprecated. Use HasValueSource.setValueSource(ValueSource) instead.

Sets datasource and its property.

getDatasource

@Deprecated
 @Nullable
default Datasource getDatasource()

Deprecated. Use HasValueSource.getValueSource() instead.

Returns:

datasource instance

getMetaPropertyPath

@Nullable
default MetaPropertyPath getMetaPropertyPath()

Returns:

return null if value source is not EntityValueSource or value source is not defined

reset

default void reset()

Resets the component source and disposes of the corresponding resource.

getScaleMode

Image.ScaleMode getScaleMode()

Returns:

image scale mode

setScaleMode

void setScaleMode(Image.ScaleMode scaleMode)

Applies the given scale mode to the image.

Parameters:

scaleMode - scale mode

addClickListener

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