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<javafx.stage.Stage>
      - io.github.mmm.ui.fx.widget.window.FxAbstractWindow

All Implemented Interfaces:

EventSource<UiEvent,UiEventListener>, AttributeReadEnabled, AttributeReadId, AttributeReadTitle, AttributeReadValid, AttributeReadVisible, AttributeWriteEnabled, AttributeWriteId, AttributeWriteMaximized, AttributeWriteMinimized, AttributeWriteReadOnly, AttributeWriteResizable, AttributeWriteTitle, AttributeWriteTooltip, AttributeWriteValidationFailure, AttributeWriteVisible, UiComposite<UiRegularWidget>, UiMutableComposite<UiRegularWidget>, UiRemovableComposite<UiRegularWidget>, UiNativeWidget, UiWidget, UiAbstractWindow, UiNativeWidgetWrapper<javafx.stage.Stage>

Direct Known Subclasses:

FxChildWindow, FxMainWindow
```
public abstract class FxAbstractWindow
extends FxWidget<javafx.stage.Stage>
implements UiAbstractWindow, AttributeWriteMinimized, AttributeWriteMaximized
```
Implementation of UiAbstractWindow for JavaFx.

Since:

1.0.0

Field Summary

Fields
Modifier and Type	Field	Description
`protected List<UiRegularWidget>`	`children`
`protected javafx.scene.layout.VBox`	`composite`	The composite where to add children.
`protected FxAbstractWindowPositionAndSize`	`positionAndSize`
`protected javafx.scene.Scene`	`scene`	The `scene`.
`protected javafx.scene.control.ScrollPane`	`scrollPane`	The optional `ScrollPane` if `scrollable`.

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

FxAbstractWindow(javafx.stage.Stage widget)
The constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addChild(UiRegularWidget child, int index)`	Inserts the given `child` at the given `index`.
`protected void`	`doDispose()`	Called from `AbstractUiNativeWidget.dispose()`
`UiRegularWidget`	`getChild(int index)`
`int`	`getChildCount()`
`int`	`getChildIndex(UiRegularWidget child)`
`protected int`	`getChildOffset()`
`UiAbstractWindow`	`getParent()`
`AttributeWritePositionRange`	`getPosition()`
`AttributeWriteSizeRange`	`getSize()`
`String`	`getTitle()`
`javafx.stage.Stage`	`getWidget()`
`protected boolean`	`isInitiallyVisible()`
`boolean`	`isMaximized()`
`boolean`	`isMinimized()`
`boolean`	`isResizable()`
`protected boolean`	`isScrollable()`
`protected boolean`	`isVisibleWithoutRoot()`
`protected void`	`registerHandlers()`	Registers the according handlers to the underlying native widget.
`UiRegularWidget`	`removeChild(int index)`	This method removes the child at the given `index` from this panel.
`protected void`	`setEnabledNative(boolean enabled)`
`protected void`	`setIdNative(String id)`
`void`	`setMaximized(boolean maximized)`
`void`	`setMinimized(boolean minimized)`
`protected void`	`setParent(UiComposite<?> parent)`
`void`	`setResizable(boolean resizable)`
`void`	`setTitle(String title)`
`protected void`	`setTooltipNative(String newTooltip)`
`protected void`	`setVisibleNative(boolean visible)`

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

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

Methods inherited from class io.github.mmm.ui.spi.widget.AbstractUiNativeWidget
addListener, dispose, doGetEnabledState, doGetVisibleState, doSetEnabledState, doSetEnabledState, doSetValidationFailure, doSetVisibleState, doSetVisibleState, ensureHandlers, fireEvent, getEventAdapter, getProgrammaticEventType, getReadOnlyFixed, getValidationFailure, hasListeners, isDisposed, isEnabled, isReadOnly, isValid, isVisible, removeListener, requireNotDisposed, setEnabled, setProgrammaticEventType, setReadOnly, setReadOnlyFixed, setValidationFailure, setVisible, unwrap, validateDown

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.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.window.UiAbstractWindow
close, findChild, open

Methods inherited from interface io.github.mmm.ui.api.widget.composite.UiComposite
getChild, getDescendant, getModificationTimestamp, getPropagation, isModified, isValid, reset, setFocused

Methods inherited from interface io.github.mmm.ui.api.widget.composite.UiMutableComposite
addChild

Methods inherited from interface io.github.mmm.ui.spi.widget.UiNativeWidgetWrapper
getTopWidget

Methods inherited from interface io.github.mmm.ui.api.widget.composite.UiRemovableComposite
removeChild

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

- Field Detail
  - scrollPane
```
protected final javafx.scene.control.ScrollPane scrollPane
```
    The optional ScrollPane if scrollable.
  - scene
```
protected final javafx.scene.Scene scene
```
    The scene.
  - composite
```
protected final javafx.scene.layout.VBox composite
```
    The composite where to add children.
  - children
```
protected final List<UiRegularWidget> children
```
    See Also:
    
    getChild(int)
  - positionAndSize
```
protected final FxAbstractWindowPositionAndSize positionAndSize
```
    See Also:
    
    getPosition(), getSize()
- Constructor Detail
  - FxAbstractWindow
```
public FxAbstractWindow(javafx.stage.Stage widget)
```
    The constructor.
    
    Parameters:
    
    widget - the JavaFx widget.
- Method Detail
  - isInitiallyVisible
```
protected boolean isInitiallyVisible()
```
    Overrides:
    
    isInitiallyVisible in class AbstractUiNativeWidget
    
    Returns:
    
    true if this widget is initially visible (locally native), false otherwise.
  - isVisibleWithoutRoot
```
protected boolean isVisibleWithoutRoot()
```
    Overrides:
    
    isVisibleWithoutRoot in class AbstractUiNativeWidget
    
    Returns:
    
    true if this is a root widget (e.g. UiMainWindow) that is visible without a parent, false otherwise.
  - getParent
```
public UiAbstractWindow getParent()
```
    Specified by:
    
    getParent in interface UiAbstractWindow
    
    Specified by:
    
    getParent in interface UiWidget
    
    Overrides:
    
    getParent in class AbstractUiNativeWidget
    
    Returns:
    
    the parent of this widget or null if not attached to the UI or if this is a root widget (e.g. the main window).
  - setParent
```
protected void setParent(UiComposite<?> parent)
```
    Overrides:
    
    setParent in class AbstractUiNativeWidget
    
    Parameters:
    
    parent - the new parent.
  - isScrollable
```
protected boolean isScrollable()
```
    Returns:
    
    true to use a ScrollPane and allow the content to scroll, false otherwise.
  - registerHandlers
```
protected void registerHandlers()
```
    Description copied from class: AbstractUiNativeWidget
    
    Registers the according handlers to the underlying native widget. Never call manually, only via AbstractUiNativeWidget.ensureHandlers().
    
    Overrides:
    
    registerHandlers in class AbstractUiNativeWidget
  - getWidget
```
public javafx.stage.Stage getWidget()
```
    Specified by:
    
    getWidget in interface UiNativeWidgetWrapper<javafx.stage.Stage>
    
    Overrides:
    
    getWidget in class FxWidget<javafx.stage.Stage>
    
    Returns:
    
    the underlying native widget wrapped by this UiNativeWidget.
  - setIdNative
```
protected void setIdNative(String id)
```
    Specified by:
    
    setIdNative in class AbstractUiNativeWidgetWrapper<javafx.stage.Stage>
    
    Parameters:
    
    id - the new ID.
  - setVisibleNative
```
protected void setVisibleNative(boolean visible)
```
    Specified by:
    
    setVisibleNative in class AbstractUiNativeWidget
    
    Parameters:
    
    visible - true to show this widget (in case its parent is also visible), false to hide this widget.
  - setTooltipNative
```
protected void setTooltipNative(String newTooltip)
```
    Specified by:
    
    setTooltipNative in class AbstractUiNativeWidgetWrapper<javafx.stage.Stage>
    
    Parameters:
    
    newTooltip - the new tooltip to apply.
  - getPosition
```
public AttributeWritePositionRange getPosition()
```
    Specified by:
    
    getPosition in interface UiAbstractWindow
    
    Returns:
    
    access to read and write the position of this window.
  - getSize
```
public AttributeWriteSizeRange getSize()
```
    Specified by:
    
    getSize in interface UiAbstractWindow
    
    Returns:
    
    access to read and write the size of this window.
  - isResizable
```
public boolean isResizable()
```
    Specified by:
    
    isResizable in interface AttributeWriteResizable
    
    Returns:
    
    true if this object can be resized by the end-user, false otherwise.
  - setResizable
```
public void setResizable(boolean resizable)
```
    Specified by:
    
    setResizable in interface AttributeWriteResizable
    
    Parameters:
    
    resizable - is the new value of AttributeWriteResizable.isResizable().
  - getTitle
```
public String getTitle()
```
    Specified by:
    
    getTitle in interface AttributeReadTitle
    
    Returns:
    
    the title of this object. Similar to text but more exposed (e.g. displayed in title-bar in case of a window). Will be the empty String if not set.
  - setTitle
```
public void setTitle(String title)
```
    Specified by:
    
    setTitle in interface AttributeWriteTitle
    
    Parameters:
    
    title - the new value of title.
  - setEnabledNative
```
protected void setEnabledNative(boolean enabled)
```
    Specified by:
    
    setEnabledNative in class AbstractUiNativeWidget
    
    Parameters:
    
    enabled - the new enabled state. Use true to enable and false to disable this widget.
  - getChildOffset
```
protected int getChildOffset()
```
    Returns:
    
    the offset for the composite if internal widgets are on top.
  - getChildCount
```
public int getChildCount()
```
    Specified by:
    
    getChildCount in interface UiComposite<UiRegularWidget>
    
    Returns:
    
    the number of direct children contained in this widget.
  - getChild
```
public UiRegularWidget getChild(int index)
```
    Specified by:
    
    getChild in interface UiComposite<UiRegularWidget>
    
    Parameters:
    
    index - is the index of the requested child. Should be in the range from 0 to UiComposite.getChildCount() - 1.
    
    Returns:
    
    the requested child or null if no such child exists.
    
    See Also:
    
    List.get(int)
  - getChildIndex
```
public int getChildIndex(UiRegularWidget child)
```
    Specified by:
    
    getChildIndex in interface UiComposite<UiRegularWidget>
    
    Parameters:
    
    child - the child to look for.
    
    Returns:
    
    the index of the given child or -1 if no such child exists.
  - addChild
```
public void addChild(UiRegularWidget child,
                     int index)
```
    Description copied from interface: UiMutableComposite
    
    Inserts the given child at the given index.
    
    Specified by:
    
    addChild in interface UiMutableComposite<UiRegularWidget>
    
    Parameters:
    
    child - is the UiWidget to add as child of this composite.
    
    index - is the index of the new child. It has to be in the range from 0 to UiComposite.getChildCount().
    
    See Also:
    
    UiMutableComposite.addChild(UiWidget), List.add(int, Object)
  - removeChild
```
public UiRegularWidget removeChild(int index)
```
    Description copied from interface: UiRemovableComposite
    
    This method removes the child at the given index from this panel.
    
    Specified by:
    
    removeChild in interface UiRemovableComposite<UiRegularWidget>
    
    Parameters:
    
    index - is the index of the child to remove. It has to be in the range from 0 to UiComposite.getChildCount() - 1.
    
    Returns:
    
    the removed child that has previously been at the given index.
    
    See Also:
    
    List.remove(int)
  - isMaximized
```
public boolean isMaximized()
```
    Specified by:
    
    isMaximized in interface AttributeWriteMaximized
    
    Returns:
    
    true if this widget is currently maximized (full-screen so its size covers the entire screen), false otherwise.
  - setMaximized
```
public void setMaximized(boolean maximized)
```
    Specified by:
    
    setMaximized in interface AttributeWriteMaximized
    
    Parameters:
    
    maximized - true to maximize, false to un-maximize (size and position will be restored to the values before it was maximized).
    
    See Also:
    
    AttributeWriteMaximized.isMaximized()
  - isMinimized
```
public boolean isMinimized()
```
    Specified by:
    
    isMinimized in interface AttributeWriteMinimized
    
    Returns:
    
    true if this object (window) is currently minimized (iconified, hidden to taskbar), false otherwise.
  - setMinimized
```
public void setMinimized(boolean minimized)
```
    Specified by:
    
    setMinimized in interface AttributeWriteMinimized
    
    Parameters:
    
    minimized - true to minimize, false to normalize (size and position will be restored to the values before it was minimized).
    
    See Also:
    
    AttributeWriteMinimized.isMinimized()
  - doDispose
```
protected final void doDispose()
```
    Description copied from class: AbstractUiNativeWidget
    
    Called from AbstractUiNativeWidget.dispose()
    
    Overrides:
    
    doDispose in class AbstractUiNativeWidget

Class FxAbstractWindow

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.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.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.window.UiAbstractWindow

Methods inherited from interface io.github.mmm.ui.api.widget.composite.UiComposite

Methods inherited from interface io.github.mmm.ui.api.widget.composite.UiMutableComposite

Methods inherited from interface io.github.mmm.ui.spi.widget.UiNativeWidgetWrapper

Methods inherited from interface io.github.mmm.ui.api.widget.composite.UiRemovableComposite

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

Field Detail

scrollPane

scene

composite

children

positionAndSize

Constructor Detail

FxAbstractWindow

Method Detail

isInitiallyVisible

isVisibleWithoutRoot

getParent

setParent

isScrollable

registerHandlers

getWidget

setIdNative

setVisibleNative

setTooltipNative

getPosition

getSize

isResizable

setResizable

getTitle

setTitle

setEnabledNative

getChildOffset

getChildCount

getChild

getChildIndex

addChild

removeChild

isMaximized

setMaximized

isMinimized

setMinimized

doDispose