Package net.infonode.docking

Class RootWindow

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
net.infonode.gui.panel.BaseContainer
net.infonode.gui.panel.BasePanel
net.infonode.docking.DockingWindow
net.infonode.docking.RootWindow
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible, Readable, ReadWritable, Writable
public class RootWindow extends DockingWindow implements ReadWritable
The root window is a top level container for docking windows. Docking windows can't be dragged outside of their root window. The property values of a root window is inherited to the docking windows inside it.
See Also:

  • Constructor Details

    • RootWindow

      public RootWindow(ViewSerializer viewSerializer)
      Creates an empty root window.
      Parameters:
      viewSerializer - used when reading and writing views
      Since:
      IDW 1.1.0

    • RootWindow

      public RootWindow(boolean heavyweightSupport, ViewSerializer viewSerializer)
      Creates an empty root window with support for heavyweight components inside the views.
      Parameters:
      heavyweightSupport - true for heavy weight component support, otherwise false
      viewSerializer - used when reading and writing views
      Since:
      IDW 1.4.0

    • RootWindow

      public RootWindow(ViewSerializer viewSerializer, DockingWindow window)
      Creates a root window with the given window as window inside this root window.
      Parameters:
      viewSerializer - used when reading and writing views
      window - the window that is placed inside the root window

    • RootWindow

      public RootWindow(boolean heavyweightSupport, ViewSerializer viewSerializer, DockingWindow window)
      Creates a root window with support for heavyweight components inside the views and the given window inside as window inside this root window.
      Parameters:
      heavyweightSupport - true for heavy weight component support, otherwise false
      viewSerializer - used when reading and writing views
      window - the window that is placed inside the root window
      Since:
      IDW 1.4.0

  • Method Details

    • getFocusedView

      public View getFocusedView()
      Returns the view that currently contains the focus.
      Returns:
      The currently focused view, null if no view has focus

    • getRootWindowProperties

      public RootWindowProperties getRootWindowProperties()
      Returns the property values for this root window. The property values will be inherited to docking windows inside this root window.
      Returns:
      the property values for this root window

    • getClosestWindowBar

      public Direction getClosestWindowBar(DockingWindow window)
      Returns the direction of the closest enabled window bar to a docking window. The distance is measured from the window edge that is furthest away from the bar.
      Parameters:
      window - the docking window
      Returns:
      the direction of the closest enabled window bar to a docking window

    • getWindowBar

      public WindowBar getWindowBar(Direction direction)
      Returns the window bar in the direction.
      Parameters:
      direction - the direction
      Returns:
      the window bar in the direction

    • setWindow

      public void setWindow(DockingWindow newWindow)
      Sets the top level docking window inside this root window.
      Parameters:
      newWindow - the top level docking window

    • getWindow

      public DockingWindow getWindow()
      Returns the top level docking window inside this root window.
      Returns:
      the top level docking window inside this root window

    • createFloatingWindow

      public FloatingWindow createFloatingWindow(Point location, Dimension innerSize, DockingWindow window)

      Creates and shows a floating window with the given window as top-level window in the floating window or without any top-level window i.e. empty floating window.

      Note 1: The created floating window is not visible per default. To make it visible, call FloatingWindow.getTopLevelAncestor().setVisible(true);

      Note 2: Floating windows are dynamically created when a window is undocked and closed/removed when all windows inside the floating window has been removed (i.e. cloased/docked/undocked to another floating window) from the floating window. The root window has a refernce to the floating window as long as the floating window has windows inside it i.e. it is not necessary to keep references to the floating window because the root window will handle this.

      Parameters:
      location - the floating window's location on the screen
      innerSize - the inner dimension of the floating window's top level container i.e.the size of the root pane
      window - the docking window that is the top level window in this floating window or null for no top-level window i.e. empty floating window
      Returns:
      the floating window
      Since:
      IDW 1.4.0

    • getViewSerializer

      public ViewSerializer getViewSerializer()
      Returns the view serializer object for the views inside this root window.
      Returns:
      the view serializer object for the views inside this root window

    • getChildWindow

      public DockingWindow getChildWindow(int index)
      Description copied from class: DockingWindow
      Returns the child window with index index.
      Specified by:
      getChildWindow in class DockingWindow
      Parameters:
      index - the child window index
      Returns:
      the child window

    • getChildWindowCount

      public int getChildWindowCount()
      Description copied from class: DockingWindow
      Returns the number of child windows.
      Specified by:
      getChildWindowCount in class DockingWindow
      Returns:
      the number of child windows

    • getIcon

      public Icon getIcon()
      Description copied from class: DockingWindow
      Returns the icon for this window.
      Specified by:
      getIcon in class DockingWindow
      Returns:
      the icon

    • write

      public void write(ObjectOutputStream out) throws IOException
      Writes the state of this root window and all child windows.
      Specified by:
      write in interface Writable
      Parameters:
      out - the stream on which to write the state
      Throws:
      IOException - if there is a stream error

    • write

      public void write(ObjectOutputStream out, boolean writeProperties) throws IOException
      Writes the state of this root window and all child windows.
      Parameters:
      out - the stream on which to write the state
      writeProperties - true if the property values for all docking windows should be written to the stream
      Throws:
      IOException - if there is a stream error

    • read

      public void read(ObjectInputStream in) throws IOException
      Reads a previously written window state. This will create child windows and read their state.
      Specified by:
      read in interface Readable
      Parameters:
      in - the stream from which to read the state
      Throws:
      IOException - if there is a stream error

    • read

      public void read(ObjectInputStream in, boolean readProperties) throws IOException
      Reads a previously written window state. This will create child windows and read their state.
      Parameters:
      in - the stream from which to read the state
      readProperties - true if the property values for all child windows should be read. This parameter can be set to true or false regardless of if the property values was included when the state was written, though obviously no property values are read if there aren't any in the stream.
      Throws:
      IOException - if there is a stream error

    • getMaximizedWindow

      public DockingWindow getMaximizedWindow()
      Returns the maximized window in this root window, or null if there no maximized window.
      Returns:
      the maximized window in this root window, or null if there no maximized window
      Since:
      IDW 1.1.0

    • setMaximizedWindow

      public void setMaximizedWindow(DockingWindow window)
      Sets the maximized window in this root window. This method takes the window component and displays it at the top in the root window. It does NOT modify the window tree structure, ie the window parent remains the unchanged.
      Parameters:
      window - the maximized window in this root window, null means no maximized window
      Since:
      IDW 1.1.0

    • removeView

      public void removeView(View view)
      Removes all internal references to a view. It's not possible to restore the view to the previous location after this method has been called. If the view is located in the window tree where this is the root nothing happens.
      Parameters:
      view - all internal references to this view are removed
      Since:
      IDW 1.4.0

    • showChildWindow

      protected void showChildWindow(DockingWindow window)
      Overrides:
      showChildWindow in class DockingWindow

    • update

      protected void update()
      Specified by:
      update in class DockingWindow

    • doReplace

      protected void doReplace(DockingWindow oldWindow, DockingWindow newWindow)
      Specified by:
      doReplace in class DockingWindow

    • doRemoveWindow

      protected void doRemoveWindow(DockingWindow window)
      Specified by:
      doRemoveWindow in class DockingWindow

    • getRootWindow

      public RootWindow getRootWindow()
      Description copied from class: DockingWindow
      Returns the RootWindow which contains this window, null if there is none.
      Overrides:
      getRootWindow in class DockingWindow
      Returns:
      the RootWindow, null if there is none

    • acceptsSplitWith

      protected boolean acceptsSplitWith(DockingWindow window)
      Overrides:
      acceptsSplitWith in class DockingWindow

    • doAcceptDrop

      protected DropAction doAcceptDrop(Point p, DockingWindow window)
      Overrides:
      doAcceptDrop in class DockingWindow

    • acceptInteriorDrop

      protected DropAction acceptInteriorDrop(Point p, DockingWindow window)
      Overrides:
      acceptInteriorDrop in class DockingWindow

    • getPropertyObject

      protected PropertyMap getPropertyObject()
      Specified by:
      getPropertyObject in class DockingWindow

    • createPropertyObject

      protected PropertyMap createPropertyObject()
      Specified by:
      createPropertyObject in class DockingWindow

    • cleanUpModel

      protected void cleanUpModel()
      Overrides:
      cleanUpModel in class DockingWindow

    • isShowingInRootWindow

      protected boolean isShowingInRootWindow()
      Overrides:
      isShowingInRootWindow in class DockingWindow

    • updateUI

      public void updateUI()
      Overrides:
      updateUI in class JPanel

    • paintComponent

      protected void paintComponent(Graphics g)
      Overrides:
      paintComponent in class BaseContainer