java.lang.Object
- io.github.mmm.ui.api.widget.AbstractUiWidget
- - io.github.mmm.ui.spi.widget.AbstractUiNativeWidget
  - - io.github.mmm.ui.spi.widget.AbstractUiNativeWidgetWrapper<W>
    - - io.github.mmm.ui.fx.widget.FxWidget<W>
      - io.github.mmm.ui.fx.widget.FxWidgetStyleable<W>
        
        io.github.mmm.ui.fx.widget.FxWidgetNode<W>
        
        io.github.mmm.ui.fx.widget.media.FxMediaWidget<W>

Type Parameters:

W - type of JavaFx widget.

All Implemented Interfaces:

EventSource<UiEvent,UiEventListener>, AttributeFeatureMedia, AttributeFeaturePlayback, AttributeFeatureVolume, AttributeReadEnabled, AttributeReadId, AttributeReadValid, AttributeReadVisible, AttributeWriteEnabled, AttributeWriteId, AttributeWriteReadOnly, AttributeWriteTooltip, AttributeWriteValidationFailure, AttributeWriteVisible, UiMediaWidget, UiNativeWidget, UiRegularWidget, UiWidget, UiNativeWidgetWrapper<W>

Direct Known Subclasses:

FxMediaPlayer
```
public abstract class FxMediaWidget<W extends javafx.scene.Node>
extends FxWidgetNode<W>
implements UiMediaWidget
```
Implementation of UiMediaWidget for JavaFx.

Since:

1.0.0

Field Summary

Fields
Modifier and Type Field Description

protected io.github.mmm.ui.fx.widget.media.fx.MediaPlayerAdapter mediaPlayerAdapter
The MediaPlayerAdapter.
- Fields inherited from class io.github.mmm.ui.fx.widget.FxWidget
  CLASS_INVALID, CLASS_READ_ONLY, widget
- Fields inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteValidationFailure
  STYLE_INVALID

Constructor Summary

Constructors
Constructor Description

FxMediaWidget(W widget)
The constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`checkMediaType(UiMediaType type)`
`protected io.github.mmm.ui.fx.widget.media.fx.MediaPlayerAdapter`	`createMediaPlayerAdapter()`
`double`	`getDuration()`
`UiMedia`	`getMedia()`
`double`	`getPosition()`
`double`	`getVolume()`	This method gets the volume of this object.
`boolean`	`isMuted()`
`boolean`	`isPlaying()`
`void`	`setMedia(UiMedia media)`
`void`	`setMuted(boolean muted)`
`void`	`setPlaying(boolean playing)`
`void`	`setPosition(double position)`
`void`	`setVolume(double volume)`

Methods inherited from class io.github.mmm.ui.fx.widget.FxWidgetNode
getTopWidget, setEnabledNative, setIdNative, setReadOnlyNative, setTooltipNative, setVisibleNative

Methods inherited from class io.github.mmm.ui.fx.widget.FxWidgetStyleable
createStyles

Methods inherited from class io.github.mmm.ui.fx.widget.FxWidget
getTopNode, getWidget, onAction, onClose, onFocusChange, onFocusChanged, onValueChange, onValueChanged, setTooltip, setWidget

Methods inherited from class io.github.mmm.ui.spi.widget.AbstractUiNativeWidgetWrapper
createDefaultStyles, getId, getStyles, getTooltip, onStylesChanged, setId, setTooltip

Methods inherited from class io.github.mmm.ui.api.widget.AbstractUiWidget
isEmpty, setParent, unwrap

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeFeaturePlayback
pause, play

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeFeatureVolume
mute, unmute

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeReadId
getId

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteId
setId

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteTooltip
getTooltip, setTooltip

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteValidationFailure
setValidationFailure

Methods inherited from interface io.github.mmm.event.EventSource
addListener, addListener, addWeakListener, removeListener

Methods inherited from interface io.github.mmm.ui.api.widget.UiWidget
cast, dispose, getModificationTimestamp, getParent, getReadOnlyFixed, getStyles, isDisposed, isEnabled, isEnabled, isFocused, isModified, isReadOnly, isValid, isVisible, isVisible, reset, setEnabled, setEnabled, setFocused, setReadOnly, setReadOnlyFixed, setVisible, setVisible, validate, validate, validate, validateDown, validateUp

- Field Detail
  - mediaPlayerAdapter
```
protected final io.github.mmm.ui.fx.widget.media.fx.MediaPlayerAdapter mediaPlayerAdapter
```
    The MediaPlayerAdapter.
- Constructor Detail
  - FxMediaWidget
```
public FxMediaWidget(W widget)
```
    The constructor.
    
    Parameters:
    
    widget - the JavaFx widget.
- Method Detail
  - createMediaPlayerAdapter
```
protected io.github.mmm.ui.fx.widget.media.fx.MediaPlayerAdapter createMediaPlayerAdapter()
```
    Returns:
    
    the MediaPlayerAdapter.
  - getMedia
```
public UiMedia getMedia()
```
    Specified by:
    
    getMedia in interface UiMediaWidget
    
    Returns:
    
    the UiMedia or null in not set.
  - setMedia
```
public void setMedia(UiMedia media)
```
    Specified by:
    
    setMedia in interface UiMediaWidget
    
    Parameters:
    
    media - the UiMedia to set and load.
  - checkMediaType
```
protected void checkMediaType(UiMediaType type)
```
    Parameters:
    
    type - the UiMediaType to verify.
  - isPlaying
```
public boolean isPlaying()
```
    Specified by:
    
    isPlaying in interface AttributeFeaturePlayback
    
    Returns:
    
    true if the media is currently playing, false otherwise (if paused or nothing to play).
  - setPlaying
```
public void setPlaying(boolean playing)
```
    Specified by:
    
    setPlaying in interface AttributeFeaturePlayback
    
    Parameters:
    
    playing - is the new value of AttributeFeaturePlayback.isPlaying(). Use true to play or resume and false to pause. Please note that if no media is present or it is invalid, it will not get into playing state even after providing true
  - getVolume
```
public double getVolume()
```
    Description copied from interface: AttributeFeatureVolume
    
    This method gets the volume of this object. Please note that the actual volume might be influenced by the mixer of the operating system. This is just a relative scale to the system volume.
    
    Specified by:
    
    getVolume in interface AttributeFeatureVolume
    
    Returns:
    
    the volume in the range from 0.0 (mute) to 1.0 (maximum).
    
    See Also:
    
    AttributeFeatureVolume.isMuted()
  - setVolume
```
public void setVolume(double volume)
```
    Specified by:
    
    setVolume in interface AttributeFeatureVolume
    
    Parameters:
    
    volume - is the new value of AttributeFeatureVolume.getVolume(). If negative, set to 0 and if greater than 1 set to 1.
  - isMuted
```
public boolean isMuted()
```
    Specified by:
    
    isMuted in interface AttributeFeatureVolume
    
    Returns:
    
    true if muted (audio is suppressed without setting volume to 0 so the volume is not lost), false otherwise.
  - setMuted
```
public void setMuted(boolean muted)
```
    Specified by:
    
    setMuted in interface AttributeFeatureVolume
    
    Parameters:
    
    muted - the new value of AttributeFeatureVolume.isMuted().
  - getPosition
```
public double getPosition()
```
    Specified by:
    
    getPosition in interface AttributeFeatureMedia
    
    Returns:
    
    the current position of the playback as factor in the range from 0 (0%, start) to 1 (100%, end).
  - setPosition
```
public void setPosition(double position)
```
    Specified by:
    
    setPosition in interface AttributeFeatureMedia
    
    Parameters:
    
    position - is the new value of AttributeFeatureMedia.getPosition(). If negative, set to 0 and if greater than 1 set to 1.
  - getDuration
```
public double getDuration()
```
    Specified by:
    
    getDuration in interface AttributeFeatureMedia
    
    Returns:
    
    the duration of the current media in seconds. Will be 0 if no media is present, media is invalid or empty.

Class FxMediaWidget<W extends javafx.scene.Node>

Field Summary

Fields inherited from class io.github.mmm.ui.fx.widget.FxWidget

Fields inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteValidationFailure

Constructor Summary

Method Summary

Methods inherited from class io.github.mmm.ui.fx.widget.FxWidgetNode

Methods inherited from class io.github.mmm.ui.fx.widget.FxWidgetStyleable

Methods inherited from class io.github.mmm.ui.fx.widget.FxWidget

Methods inherited from class io.github.mmm.ui.spi.widget.AbstractUiNativeWidgetWrapper

Methods inherited from class io.github.mmm.ui.spi.widget.AbstractUiNativeWidget

Methods inherited from class io.github.mmm.ui.api.widget.AbstractUiWidget

Methods inherited from class java.lang.Object

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeFeaturePlayback

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeFeatureVolume

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeReadId

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteId

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteTooltip

Methods inherited from interface io.github.mmm.ui.api.attribute.AttributeWriteValidationFailure

Methods inherited from interface io.github.mmm.event.EventSource

Methods inherited from interface io.github.mmm.ui.api.widget.UiWidget

Field Detail

mediaPlayerAdapter

Constructor Detail

FxMediaWidget

Method Detail

createMediaPlayerAdapter

getMedia

setMedia

checkMediaType

isPlaying

setPlaying

getVolume

setVolume

isMuted

setMuted

getPosition

setPosition

getDuration