com.haulmont.cuba.gui.components

Interface ResourceView

All Superinterfaces:

Component, Component.HasCaption, Component.HasDescription, HasContextHelp, HasHtmlCaption, HasHtmlDescription

All Known Subinterfaces:

BrowserFrame, Image

public interface ResourceView
extends Component, Component.HasCaption, HasContextHelp, HasHtmlCaption, HasHtmlDescription

A class that implements this interface is intended for viewing different resources, e.g. UrlResource, FileResource, etc.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ResourceView.HasMimeType Marker interface to indicate that the implementing class supports MIME type setting.
static interface	ResourceView.HasStreamSettings Marker interface to indicate that the implementing class has stream settings (such as cache time, buffer size or file name).
static class	ResourceView.SourceChangeEvent SourceChangeEvent is fired when a source is changed.

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 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	addSourceChangeListener(java.util.function.Consumer<ResourceView.SourceChangeEvent> listener) Adds a listener that will be notified when a source is changed.
<R extends Resource> R	createResource(java.lang.Class<R> type) Creates resource implementation by its type.
java.lang.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	removeSourceChangeListener(java.util.function.Consumer<ResourceView.SourceChangeEvent> listener) Deprecated. Use Subscription instead
void	setAlternateText(java.lang.String alternateText) Sets this component's alternate text that can be presented instead of the component's normal content for accessibility purposes.
<R extends Resource> R	setSource(java.lang.Class<R> type) Creates the resource with the given type and sets it to the component.
void	setSource(Resource resource) Sets the given Resource to the component.

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

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

Method Detail

getSource

Resource getSource()

Returns:

Resource instance

setSource

void setSource(Resource resource)

Sets the given Resource to the component.

Parameters:

resource - Resource instance

setSource

<R extends Resource> R setSource(java.lang.Class<R> type)

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

Type Parameters:

R - Resource inheritor

Parameters:

type - resource class to be created

Returns:

new resource instance

createResource

<R extends Resource> R createResource(java.lang.Class<R> type)

Creates resource implementation by its type.

Type Parameters:

R - Resource inheritor

Parameters:

type - resource class to be created

Returns:

new resource instance with given type

setAlternateText

void setAlternateText(java.lang.String alternateText)

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

Parameters:

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

getAlternateText

java.lang.String getAlternateText()

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

Returns:

alternate text

addSourceChangeListener

Subscription addSourceChangeListener(java.util.function.Consumer<ResourceView.SourceChangeEvent> listener)

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

removeSourceChangeListener

@Deprecated
void removeSourceChangeListener(java.util.function.Consumer<ResourceView.SourceChangeEvent> listener)

Deprecated. Use Subscription instead

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

Parameters:

listener - a listener to remove