XdevRootPaneContainer (XDEV Application Framework 6.0.0 API)

All Superinterfaces:

RootPaneContainer

All Known Subinterfaces:

XdevApplicationContainer

All Known Implementing Classes:

Application, XdevDialog, XdevFrame, XdevFullScreen, XdevMainFrame, XdevPageContainer, XdevScreen, XdevWindowContainer
```
public interface XdevRootPaneContainer
extends RootPaneContainer
```
A root pane container is basically a container which is able to contain and manage a XdevWindow, see setXdevWindow(XdevWindow).

Author:

XDEV Software

See Also:

XdevApplicationContainer, RootPaneContainer

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class XdevRootPaneContainer.Util

Nested Classes
Modifier and Type	Interface and Description
`static class`	`XdevRootPaneContainer.Util`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ICONIFIED` This state bit indicates that container is iconified.
`static int`	`MAXIMIZED_BOTH` This state bit mask indicates that container is fully maximized (that is both horizontally and vertically).
`static int`	`MAXIMIZED_HORIZ` This state bit indicates that container is maximized in the horizontal direction.
`static int`	`MAXIMIZED_VERT` This state bit indicates that container is maximized in the vertical direction.
`static int`	`NORMAL` Container is in the "normal" state.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addWindowListener(WindowListener listener)` Adds the specified window listener to receive window events.
`void`	`close()` Closes this container and releases all used resources.
`Rectangle`	`getBounds()` Returns the size of the `XdevRootPaneContainer`.
`int`	`getExtendedState()` Gets the state of this container.
`Point`	`getLocation()` Returns the location of the `XdevRootPaneContainer`.
`Dimension`	`getSize()` Returns the size of the `XdevRootPaneContainer`.
`Window`	`getWindow()` Returns the `Window` of this `XdevRootPaneContainer`.
`XdevWindow`	`getXdevWindow()` Returns the internal `XdevWindow` of this `XdevRootPaneContainer`.
`void`	`pack()` Causes this Window to be sized to fit the preferred size and layouts of its subcomponents.
`void`	`removeWindowListener(WindowListener listener)` Removes the specified window listener to receive window events.
`void`	`setBounds(int x, int y, int w, int h)` Moves and resizes this `XdevRootPaneContainer`.
`void`	`setExtendedState(int extendedState)` Sets the state of this container.
`void`	`setLocation(int x, int y)` Moves this `XdevRootPaneContainer` to a new location.
`void`	`setLocationRelativeTo(Component c)` Sets the location of the `XdevRootPaneContainer` relative to the specified component.
`void`	`setResizable(boolean b)` Sets whether this `XdevRootPaneContainer` is resizable by the user.
`void`	`setTitle(String s)` Sets the title of this `XdevRootPaneContainer`.
`void`	`setVisible(boolean b)` Makes the `XdevRootPaneContainer` visible or invisible.
`void`	`setXdevWindow(XdevWindow window)` Sets the content of this `XdevRootPaneContainer`.
`void`	`toBack()` If this Window is visible, sends this Window to the back and may cause it to lose focus or activation if it is the focused or active Window.
`void`	`toFront()` If this Window is visible, brings this Window to the front and may make it the focused Window.

Methods inherited from interface javax.swing.RootPaneContainer
getContentPane, getGlassPane, getLayeredPane, getRootPane, setContentPane, setGlassPane, setLayeredPane

- Field Detail
  - NORMAL
```
static final int NORMAL
```
    Container is in the "normal" state. This symbolic constant names a container state with all state bits cleared.
    
    See Also:
    
    setExtendedState(int), Constant Field Values
  - ICONIFIED
```
static final int ICONIFIED
```
    This state bit indicates that container is iconified.
    
    See Also:
    
    setExtendedState(int), Constant Field Values
  - MAXIMIZED_HORIZ
```
static final int MAXIMIZED_HORIZ
```
    This state bit indicates that container is maximized in the horizontal direction.
    
    See Also:
    
    setExtendedState(int), Constant Field Values
  - MAXIMIZED_VERT
```
static final int MAXIMIZED_VERT
```
    This state bit indicates that container is maximized in the vertical direction.
    
    See Also:
    
    setExtendedState(int), Constant Field Values
  - MAXIMIZED_BOTH
```
static final int MAXIMIZED_BOTH
```
    This state bit mask indicates that container is fully maximized (that is both horizontally and vertically). It is just a convenience alias for MAXIMIZED_VERT | MAXIMIZED_HORIZ.
    
    See Also:
    
    setExtendedState(int), Constant Field Values
- Method Detail
  - getWindow
```
Window getWindow()
```
    Returns the Window of this XdevRootPaneContainer.
    
    Returns:
    
    the Window of this XdevRootPaneContainer
  - setXdevWindow
```
void setXdevWindow(XdevWindow window)
```
    Sets the content of this XdevRootPaneContainer.
    
    Parameters:
    
    window - the XdevWindow for this XdevRootPaneContainer
  - getXdevWindow
```
XdevWindow getXdevWindow()
```
    Returns the internal XdevWindow of this XdevRootPaneContainer.
    
    Returns:
    
    the internal XdevWindow
  - addWindowListener
```
void addWindowListener(WindowListener listener)
```
    Adds the specified window listener to receive window events.
    
    Parameters:
    
    listener - the window listener
  - removeWindowListener
```
void removeWindowListener(WindowListener listener)
```
    Removes the specified window listener to receive window events.
    
    Parameters:
    
    listener - the window listener
    
    Since:
    
    4.0
  - setVisible
```
void setVisible(boolean b)
```
    Makes the XdevRootPaneContainer visible or invisible.
    
    Parameters:
    
    b - true to make the container visible; false to make it invisible
  - pack
```
void pack()
```
    Causes this Window to be sized to fit the preferred size and layouts of its subcomponents. If the window and/or its owner are not yet displayable, both are made displayable before calculating the preferred size. The Window will be validated after the preferredSize is calculated.
    If this container isn't a Window this method has no effect.
    
    See Also:
    
    Component.isDisplayable()
  - setLocationRelativeTo
```
void setLocationRelativeTo(Component c)
```
    Sets the location of the XdevRootPaneContainer relative to the specified component.
    
    Parameters:
    
    c - the component in relation to which the XdevRootPaneContainer location is determined
  - getLocation
```
Point getLocation()
```
    Returns the location of the XdevRootPaneContainer.
    
    Returns:
    
    the location as Point
  - getSize
```
Dimension getSize()
```
    Returns the size of the XdevRootPaneContainer.
    
    Returns:
    
    the size as Dimension
  - getBounds
```
Rectangle getBounds()
```
    Returns the size of the XdevRootPaneContainer.
    
    Returns:
    
    the size as Dimension
  - setLocation
```
void setLocation(int x,
                 int y)
```
    Moves this XdevRootPaneContainer to a new location.
    
    Parameters:
    
    x - the x-coordinate of the new location
    
    y - the y-coordinate of the new location
    
    See Also:
    
    getLocation(), setBounds(int, int, int, int)
  - setBounds
```
void setBounds(int x,
               int y,
               int w,
               int h)
```
    Moves and resizes this XdevRootPaneContainer. The new location of the top-left corner is specified by x and y, and the new size is specified by w and h.
    
    Parameters:
    
    x - the new x-coordinate of this XdevRootPaneContainer
    
    y - the new y-coordinate of this XdevRootPaneContainer
    
    w - the new width of this XdevRootPaneContainer
    
    h - the new height of this XdevRootPaneContainer
    
    See Also:
    
    getBounds(), setLocation(int, int)
  - toFront
```
void toFront()
```
    If this Window is visible, brings this Window to the front and may make it the focused Window.
    If this container isn't a Window this method has no effect.
    Places this Window at the top of the stacking order and shows it in front of any other Windows in this VM. No action will take place if this Window is not visible. Some platforms do not allow Windows which own other Windows to appear on top of those owned Windows. Some platforms may not permit this VM to place its Windows above windows of native applications, or Windows of other VMs. This permission may depend on whether a Window in this VM is already focused. Every attempt will be made to move this Window as high as possible in the stacking order; however, developers should not assume that this method will move this Window above all other windows in every situation.
    Because of variations in native windowing systems, no guarantees about changes to the focused and active Windows can be made. Developers must never assume that this Window is the focused or active Window until this Window receives a WINDOW_GAINED_FOCUS or WINDOW_ACTIVATED event. On platforms where the top-most window is the focused window, this method will probably focus this Window, if it is not already focused. On platforms where the stacking order does not typically affect the focused window, this method will probably leave the focused and active Windows unchanged.
    If this method causes this Window to be focused, and this Window is a Frame or a Dialog, it will also become activated. If this Window is focused, but it is not a Frame or a Dialog, then the first Frame or Dialog that is an owner of this Window will be activated.
    If this window is blocked by modal dialog, then the blocking dialog is brought to the front and remains above the blocked window.
    
    See Also:
    
    toBack()
  - toBack
```
void toBack()
```
    If this Window is visible, sends this Window to the back and may cause it to lose focus or activation if it is the focused or active Window.
    If this container isn't a Window this method has no effect.
    Places this Window at the bottom of the stacking order and shows it behind any other Windows in this VM. No action will take place is this Window is not visible. Some platforms do not allow Windows which are owned by other Windows to appear below their owners. Every attempt will be made to move this Window as low as possible in the stacking order; however, developers should not assume that this method will move this Window below all other windows in every situation.
    Because of variations in native windowing systems, no guarantees about changes to the focused and active Windows can be made. Developers must never assume that this Window is no longer the focused or active Window until this Window receives a WINDOW_LOST_FOCUS or WINDOW_DEACTIVATED event. On platforms where the top-most window is the focused window, this method will probably cause this Window to lose focus. In that case, the next highest, focusable Window in this VM will receive focus. On platforms where the stacking order does not typically affect the focused window, this method will probably leave the focused and active Windows unchanged.
    
    See Also:
    
    toFront()
  - setTitle
```
void setTitle(String s)
```
    Sets the title of this XdevRootPaneContainer.
    
    Parameters:
    
    s - the title to be displayed
  - setResizable
```
void setResizable(boolean b)
```
    Sets whether this XdevRootPaneContainer is resizable by the user.
    
    Parameters:
    
    b - true if the user can resize this XdevRootPaneContainer; false otherwise.
  - setExtendedState
```
void setExtendedState(int extendedState)
```
    Sets the state of this container. The state is represented as a bitwise mask.
    If this container doesn't support an extended state this method has no effect.
    - NORMAL
      Indicates that no state bits are set.
    - ICONIFIED
    - MAXIMIZED_HORIZ
    - MAXIMIZED_VERT
    - MAXIMIZED_BOTH
      Concatenates MAXIMIZED_HORIZ and MAXIMIZED_VERT.
    Note that if the state is not supported on a given platform, nothing will happen. The application may determine if a specific state is available via the java.awt.Toolkit#isFrameStateSupported(int state) method.
    Parameters:
    
    extendedState - a bitwise mask of frame state constants
    
    Since:
    
    3.1
    
    See Also:
    
    getExtendedState(), Toolkit.isFrameStateSupported(int)
  - getExtendedState
```
int getExtendedState()
```
    Gets the state of this container. The state is represented as a bitwise mask.
    
    Returns:
    
    a bitwise mask of frame state constants
    
    Since:
    
    3.1
    
    See Also:
    
    setExtendedState(int)
  - close
```
void close()
```
    Closes this container and releases all used resources.
    
    Since:
    
    4.0

Interface XdevRootPaneContainer

Nested Class Summary

Field Summary

Method Summary

Methods inherited from interface javax.swing.RootPaneContainer

Field Detail

NORMAL

ICONIFIED

MAXIMIZED_HORIZ

MAXIMIZED_VERT

MAXIMIZED_BOTH

Method Detail

getWindow

setXdevWindow

getXdevWindow

addWindowListener

removeWindowListener

setVisible

pack

setLocationRelativeTo

getLocation

getSize

getBounds

setLocation

setBounds

toFront

toBack

setTitle

setResizable

setExtendedState

getExtendedState

close