Package com.vaadin.ui

Class AbstractMedia

    • Constructor Detail

      • AbstractMedia

        public AbstractMedia()

    • Method Detail

      • getState

        protected AbstractMediaState getState()
        Description copied from class: AbstractComponent
        Returns the shared state bean with information to be sent from the server to the client. Subclasses should override this method and set any relevant fields of the state returned by super.getState().
        Overrides:
        getState in class AbstractComponent
        Returns:
        updated component shared state

      • setSource

        public void setSource​(Resource source)
        Sets a single media file as the source of the media component.
        Parameters:
        source -

      • addSource

        public void addSource​(Resource source)
        Adds an alternative media file to the sources list. Which of the sources is used is selected by the browser depending on which file formats it supports. See wikipedia for a table of formats supported by different browsers.
        Parameters:
        source -

      • handleConnectorRequest

        public boolean handleConnectorRequest​(VaadinRequest request,
                                      VaadinResponse response,
                                      String path)
                               throws IOException
        Description copied from interface: ClientConnector
        Handle a request directed to this connector. This can be used by connectors to dynamically generate a response and it is also used internally when serving ConnectorResources.

        Requests to /APP/connector/[ui id]/[connector id]/ are routed to this method with the remaining part of the requested path available in the path parameter.

        NOTE that the session is not locked when this method is called. It is the responsibility of the connector to ensure that the session is locked while handling state or other session related data. For best performance the session should be unlocked before writing a large response to the client.

        Specified by:
        handleConnectorRequest in interface ClientConnector
        Overrides:
        handleConnectorRequest in class AbstractClientConnector
        Parameters:
        request - the request that should be handled
        response - the response object to which the response should be written
        path - the requested relative path
        Returns:
        true if the request has been handled, false if no response has been written.
        Throws:
        IOException - if there is a problem generating a response.

      • setSources

        public void setSources​(Resource... sources)
        Set multiple sources at once. Which of the sources is used is selected by the browser depending on which file formats it supports. See wikipedia for a table of formats supported by different browsers.
        Parameters:
        sources -

      • getSources

        public List<Resource> getSources()
        Returns:
        The sources pointed to in this media.

      • setShowControls

        public void setShowControls​(boolean showControls)
        Sets whether or not the browser should show native media controls.
        Parameters:
        showControls -

      • isShowControls

        public boolean isShowControls()
        Returns:
        true if the browser is to show native media controls.

      • setAltText

        public void setAltText​(String altText)
        Sets the alternative text to be displayed if the browser does not support HTML5. This text is rendered as HTML if setHtmlContentAllowed(boolean) is set to true.
        Parameters:
        altText -

      • getAltText

        public String getAltText()
        Returns:
        The text/html that is displayed when a browser doesn't support HTML5.

      • setPreload

        public void setPreload​(PreloadMode preload)
        Sets the preload attribute that is intended to provide a hint to the browser how the media should be preloaded. Valid values are 'none', 'metadata', 'preload', see the Mozilla Developer Network for details.
        Parameters:
        preload - preload mode
        Since:
        7.7.11

      • getPreload

        public PreloadMode getPreload()
        Returns:
        the configured media preload value
        Since:
        7.7.11

      • setLoop

        public void setLoop​(boolean loop)
        Enables or disables looping.
        Parameters:
        loop - if true, enable looping
        Since:
        7.7.11

      • isLoop

        public boolean isLoop()
        Returns:
        true if looping is enabled
        Since:
        7.7.11

      • setHtmlContentAllowed

        public void setHtmlContentAllowed​(boolean htmlContentAllowed)
        Set whether the alternative text (setAltText(String)) is rendered as HTML or not.
        Parameters:
        htmlContentAllowed -

      • isHtmlContentAllowed

        public boolean isHtmlContentAllowed()
        Returns:
        true if the alternative text (setAltText(String)) is to be rendered as HTML.

      • setAutoplay

        public void setAutoplay​(boolean autoplay)
        Sets whether the media is to automatically start playback when enough data has been loaded.
        Parameters:
        autoplay -

      • isAutoplay

        public boolean isAutoplay()
        Returns:
        true if the media is set to automatically start playback.

      • setMuted

        public void setMuted​(boolean muted)
        Set whether to mute the audio or not.
        Parameters:
        muted -

      • isMuted

        public boolean isMuted()
        Returns:
        true if the audio is muted.

      • pause

        public void pause()
        Pauses the media.

      • play

        public void play()
        Starts playback of the media.

      • writeDesign

        public void writeDesign​(org.jsoup.nodes.Element design,
                        DesignContext designContext)
        Description copied from interface: Component
        Writes the component state to the given design.

        The component is responsible not only for writing its own state but also for ensuring that its children write their state to the design.

        This method must not modify the component state.

        Specified by:
        writeDesign in interface Component
        Overrides:
        writeDesign in class AbstractComponent
        Parameters:
        design - The element to write the component state to. Any previous attributes or child nodes are not cleared.
        designContext - The DesignContext instance used for writing the design

      • readDesign

        public void readDesign​(org.jsoup.nodes.Element design,
                       DesignContext designContext)
        Description copied from interface: Component
        Reads the component state from the given design.

        The component is responsible not only for updating its own state but also for ensuring that its children update their state based on the design.

        It is assumed that the component is in its default state when this method is called. Reading should only take into consideration attributes specified in the design and not reset any unspecified attributes to their defaults.

        This method must not modify the design.

        Specified by:
        readDesign in interface Component
        Overrides:
        readDesign in class AbstractComponent
        Parameters:
        design - The element to obtain the state from
        designContext - The DesignContext instance used for parsing the design