com.haulmont.cuba.gui.components

Interface Image

All Superinterfaces:

Component, Component.HasCaption, ResourceView

public interface Image
extends ResourceView

The Image component is intended for displaying graphic content.

It can be bound to a datasource or configured manually.

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 interface	Image.ClickListener
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, ResourceView.SourceChangeListener

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

Component.ActionOwner, Component.ActionsHolder, Component.Alignment, Component.BelongToFrame, Component.Buffered, Component.ChildEditableController, Component.Collapsable, Component.Container, Component.ContextHelpIconClickEvent, Component.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasContextHelp, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasOptionsStyleProvider, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, Component.OptionsStyleProvider, Component.OrderedContainer, Component.OuterMargin, Component.SecuredActionsHolder, Component.ShortcutAction, Component.ShortcutNotifier, Component.ShortcutTriggeredEvent, Component.Spacing, Component.UiPermissionAware, Component.Validatable, Component.ValueChangeEvent, Component.ValueChangeListener, Component.Wrapper

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, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
void	addClickListener(Image.ClickListener listener)
Datasource	getDatasource()
MetaPropertyPath	getMetaPropertyPath()
Image.ScaleMode	getScaleMode()
void	removeClickListener(Image.ClickListener listener)
void	setDatasource(Datasource datasource, java.lang.String property) Sets datasource and its property.
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, getDebugId, getHeight, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthUnits, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setDebugId, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

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

getCaption, getDescription, setCaption, setDescription

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

setDatasource

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

Sets datasource and its property.

getDatasource

Datasource getDatasource()

Returns:

datasource instance

getMetaPropertyPath

MetaPropertyPath getMetaPropertyPath()

Returns:

datasource property path

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

void addClickListener(Image.ClickListener listener)

removeClickListener

void removeClickListener(Image.ClickListener listener)