Package io.jmix.ui.component.impl

Class AbstractResourceView<T extends com.vaadin.ui.AbstractEmbedded>

java.lang.Object

io.jmix.ui.component.impl.AbstractComponent<T>

io.jmix.ui.component.impl.AbstractResourceView<T>

All Implemented Interfaces:

AttachNotifier, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, ResourceView

Direct Known Subclasses:

BrowserFrameImpl, ImageImpl

public abstract class AbstractResourceView<T extends com.vaadin.ui.AbstractEmbedded>
extends AbstractComponent<T>
implements ResourceView

Nested Class Summary

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

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

ResourceView.HasMimeType, ResourceView.HasStreamSettings, ResourceView.SourceChangeEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected Resource	resource
protected Runnable	resourceUpdateHandler

Fields inherited from class io.jmix.ui.component.impl.AbstractComponent

alignment, applicationContext, component, contextHelpIconClickHandler, contextHelpIconClickListener, descriptionAsHtml, element, frame, htmlSanitizerEnabled, icon, ICON_STYLE, id, parent

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractResourceView()

Method Summary

Modifier and Type	Method	Description
Subscription	addSourceChangeListener(Consumer<ResourceView.SourceChangeEvent> listener)	Adds a listener that will be notified when a source is changed.
String	getAlternateText()	Gets this component's alternate text that can be presented instead of the component's normal content for accessibility purposes.
Resource	getSource()
void	setAlternateText(String alternateText)	Sets this component's alternate text that can be presented instead of the component's normal content for accessibility purposes.
void	setSource(Resource resource)	Sets the given Resource to the component.
<R extends Resource> R	setSource(Class<R> type)	Creates the resource with the given type and sets it to the component.
protected void	updateValue(Resource value)

Methods inherited from class io.jmix.ui.component.impl.AbstractComponent

addAttachListener, addDetachListener, addStyleName, assignDebugId, attached, detached, getAlignment, getCaption, getComponent, getComposition, getContextHelpIconClickHandler, getContextHelpText, getDebugId, getDescription, getEventHub, getFrame, getHeight, getHeightSizeUnit, getHtmlSanitizer, getIcon, getIconName, getIconResource, getId, getParent, getStyleName, getUiComponentProperties, getUiProperties, getWidth, getWidthSizeUnit, getXmlDescriptor, hasSubscriptions, hasValidationError, isAttached, isCaptionAsHtml, isContextHelpTextHtmlEnabled, isDescriptionAsHtml, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, onContextHelpIconClick, publish, removeStyleName, sanitize, setAlignment, setApplicationContext, setCaption, setCaptionAsHtml, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setDebugId, setDescription, setDescriptionAsHtml, setEnabled, setFrame, setHeight, setHtmlSanitizerEnabled, setIcon, setIconFromSet, setId, setParent, setResponsive, setStyleName, setValidationError, setVisible, setWidth, setXmlDescriptor, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from class java.lang.Object

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

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.Component.HasCaption

getCaption, setCaption

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

getDescription, setDescription

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.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

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

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

Field Details

resource

protected Resource resource

resourceUpdateHandler

protected Runnable resourceUpdateHandler

Constructor Details

AbstractResourceView

protected AbstractResourceView()

Method Details

getSource

@Nullable
public Resource getSource()

Specified by:

getSource in interface ResourceView

Returns:

Resource instance

setSource

public void setSource(@Nullable
 Resource resource)

Description copied from interface: ResourceView

Sets the given Resource to the component.

Specified by:

setSource in interface ResourceView

Parameters:

resource - Resource instance

updateValue

protected void updateValue(@Nullable
 Resource value)

setSource

public <R extends Resource> R setSource(Class<R> type)

Description copied from interface: ResourceView

Creates the resource with the given type and sets it to the component.

Specified by:

setSource in interface ResourceView

Type Parameters:

R - Resource inheritor

Parameters:

type - resource class to be created

Returns:

new resource instance

setAlternateText

public void setAlternateText(@Nullable
 String alternateText)

Description copied from interface: ResourceView

Sets this component's alternate text that can be presented instead of the component's normal content for accessibility purposes.

Specified by:

setAlternateText in interface ResourceView

Parameters:

alternateText - a short, human-readable description of this component's content

getAlternateText

@Nullable
public String getAlternateText()

Description copied from interface: ResourceView

Gets this component's alternate text that can be presented instead of the component's normal content for accessibility purposes.

Specified by:

getAlternateText in interface ResourceView

Returns:

alternate text

addSourceChangeListener

public Subscription addSourceChangeListener(Consumer<ResourceView.SourceChangeEvent> listener)

Description copied from interface: ResourceView

Adds a listener that will be notified when a source is changed.

Specified by:

addSourceChangeListener in interface ResourceView