Package com.inductiveautomation.snap.swing

Class SwingWindow

java.lang.Object
com.inductiveautomation.snap.swing.SwingWindow
public class SwingWindow extends Object
A class to manage the Window of a SwingOwner.

  • Constructor Details

    • SwingWindow

      public SwingWindow()

  • Method Details

    • isWindowSet

      public boolean isWindowSet()
      Returns whether window has been created.

    • getWindow

      public Window getWindow()
      Returns the window associated with this panel, creating it if necessary.

    • setWindow

      protected void setWindow(Window aWindow)
      Sets a new window for this panel.

    • createWindow

      protected Window createWindow()
      Creates a window for this panel from window class.

    • getWindowCall

      public Callable<Window> getWindowCall()
      Returns the call to create the window.

    • setWindowCall

      public void setWindowCall(Callable<Window> aCall)
      Sets the call to create the window.

    • getContentPaneCall

      public Callable<JComponent> getContentPaneCall()
      Returns the Callable that provides the ContentPane.

    • setContentPaneCall

      public void setContentPaneCall(Callable<JComponent> aCall)
      Sets the Callable that provides the ContentPane.

    • getWindowClass

      public Class<? extends Window> getWindowClass()
      Returns the class of the window associated with this panel.

    • setWindowClass

      public void setWindowClass(Class<? extends Window> aClass)
      Sets the window class.

    • getTitle

      public String getTitle()
      Returns the title of the window.

    • setTitle

      public void setTitle(String aValue)
      Sets the title of the window.

    • isResizable

      public boolean isResizable()
      Returns whether the window is resizable.

    • setResizable

      public void setResizable(boolean aValue)
      Sets whether the window is resizable (default to true).

    • getStyle

      public SwingWindow.Style getStyle()
      Returns the window style.

    • setStyle

      public void setStyle(SwingWindow.Style aStyle)
      Sets the window style.

    • getMenuBar

      public JMenuBar getMenuBar()
      Returns the menu bar associated with this window.

    • setMenuBar

      public void setMenuBar(JMenuBar aMenuBar)
      Sets the menu bar associated with this window.

    • isAlwaysOnTop

      public boolean isAlwaysOnTop()
      Returns whether the window is always on top.

    • setAlwaysOnTop

      public void setAlwaysOnTop(boolean aValue)
      Sets whether the window is always on top.

    • getDocumentFile

      public File getDocumentFile()
      Returns the document file for the window title bar proxy icon.

    • setDocumentFile

      public void setDocumentFile(File aFile)
      Returns the document file for the window title bar proxy icon.

    • isHideOnDeactivate

      public boolean isHideOnDeactivate()
      Returns whether the window will hide on deactivate.

    • setHideOnDeactivate

      public void setHideOnDeactivate(boolean aValue)
      Sets whether the window will hide on deacativate.

    • getIconImage

      public Image getIconImage()
      Returns the icon image for the window.

    • setIconImage

      public void setIconImage(Image anImage)
      Sets the icon image for the window.

    • isModal

      public boolean isModal()
      Returns the modal mode of the window.

    • setModal

      public void setModal(boolean aValue)
      Sets the modal mode of the window (defaults to false).

    • getDefaultButton

      public JButton getDefaultButton()
      Returns the name of the default button associated with this window.

    • setDefaultButton

      public void setDefaultButton(JButton aButton)
      Sets the name of the default button associated with this window.

    • isUndecorated

      public boolean isUndecorated()
      Returns true if the window has no title bar or other decorations.

    • setUndecorated

      public void setUndecorated(boolean flag)
      Sets whether the window has a title bar and decorations or not. This must be done before the first call to getWindow() or an IllegalComponentStateException will be thrown.

    • addWindowListener

      public void addWindowListener(WindowListener aListener)
      Add window listener.

    • getRootPane

      public JRootPane getRootPane()
      Returns the root pane for the window.

    • getContentPane

      public Container getContentPane()
      Returns the content pane.

    • setContentPane

      public void setContentPane(Container aContainer)
      Sets the content pane.

    • getX

      public int getX()
      Returns the window x.

    • getY

      public int getY()
      Returns the window y.

    • getWidth

      public int getWidth()
      Returns the window width.

    • getHeight

      public int getHeight()
      Returns the window x.

    • getSize

      public Dimension getSize()
      Returns the window size.

    • setSize

      public void setSize(Dimension aSize)
      Returns the window size.

    • getPreferredSize

      public Dimension getPreferredSize()
      Returns the window PreferredSize.

    • getMinimumSize

      public Dimension getMinimumSize()
      Returns the window MinimumSize.

    • pack

      public void pack()
      Packs the window.

    • requestFocus

      public void requestFocus()
      Requests focus on the window.

    • toFront

      public void toFront()
      Order window to front.

    • setMaximizedBounds

      public void setMaximizedBounds(Rectangle aRect)
      Set Maximized bounds.

    • windowDispose

      public void windowDispose()
      This method disposes the window associated with this panel.

    • isVisible

      public boolean isVisible()
      Returns whether window is visible.

    • setVisible

      public void setVisible(boolean aValue)
      This method sets the window to be visible or invisible.

    • setVisible

      public void setVisible(SwingWindow.Pos aPos, int x, int y, String fsaveName, boolean doSize)
      This method set the window associated with this panel to be visible at some given x and y away from a given corner. It also allows you to provide a "frame save name" which causes the frame's location and size to be saved between sessions (in which case it will override the default position provided).

    • setVisible

      public static void setVisible(Component aWin, SwingWindow.Pos aPos, int dx, int dy, String aFrmSvName, boolean doSize)
      Makes a window visible with the given corner at the given x & y.

    • getRootPane

      public static JRootPane getRootPane(Window aWin)
      Returns the root pane for a window, if available.

    • getDocumentFile

      public static File getDocumentFile(Window aWindow)
      Returns the document file for the window title bar proxy icon.

    • setDocumentFile

      public static void setDocumentFile(Window aWindow, File aFile)
      Returns the document file for the window title bar proxy icon.