TWindow (Jexer - Java Text User Interface

java.lang.Object
- jexer.TWidget
- - jexer.TWindow

All Implemented Interfaces:

java.lang.Comparable<TWidget>

Direct Known Subclasses:

DemoCheckBoxWindow, DemoEditorWindow, DemoMainWindow, DemoMsgBoxWindow, DemoTableWindow, DemoTextFieldWindow, DemoTextWindow, DemoTreeViewWindow, TDesktop, TEditColorThemeWindow, TExceptionDialog, TFileOpenBox, TFontChooserWindow, TMenu, TMessageBox, TScrollableWindow, TWindowBackend
```
public class TWindow
extends TWidget
```
TWindow is the top-level container and drawing surface for other widgets.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ABSOLUTEXY` Window is placed at absolute position (no smart placement) (default no).
`static int`	`CENTERED` Window is centered (default no).
`static int`	`HIDEONCLOSE` Hitting the closebox with the mouse calls TApplication.hideWindow() rather than TApplication.closeWindow() (default no).
`protected boolean`	`inKeyboardResize` If true, then the user selected "Size/Move" (or hit Ctrl-F5) and is resizing/moving the window via the keyboard.
`protected boolean`	`inWindowMove` If true, then the user clicked on the title bar and is moving the window.
`protected boolean`	`inWindowResize` If true, then the user clicked on the bottom right corner and is resizing the window.
`static int`	`MODAL` Window is modal (default no).
`protected TMouseEvent`	`mouse` Remember mouse state.
`static int`	`NOCLOSEBOX` Window has no close box (default no).
`static int`	`NOZOOMBOX` Window has no maximize box (default no).
`static int`	`OVERRIDEMENU` Menus cannot be used when this window is active (default no).
`static int`	`RESIZABLE` Window is resizable (default yes).
`protected TStatusBar`	`statusBar` A window may have a status bar associated with it.

Constructor Summary

Constructors
Constructor and Description
`TWindow(TApplication application, java.lang.String title, int width, int height)` Public constructor.
`TWindow(TApplication application, java.lang.String title, int width, int height, int flags)` Public constructor.
`TWindow(TApplication application, java.lang.String title, int x, int y, int width, int height)` Public constructor.
`TWindow(TApplication application, java.lang.String title, int x, int y, int width, int height, int flags)` Public constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`activate()` Activate window (bring to top and receive events).
`protected void`	`addShortcutKeypress(TKeypress key)` Add a keypress to be overridden for this window.
`void`	`center()` Recenter the window on-screen.
`protected void`	`clearShortcutKeypresses()` Remove all keypresses to be overridden for this window.
`void`	`close()` Close window.
`void`	`draw()` Called by TApplication.drawChildren() to render on screen.
`TApplication`	`getApplication()` Get this TWindow's parent TApplication.
`CellAttributes`	`getBackground()` Retrieve the background color.
`CellAttributes`	`getBorder()` Retrieve the border color.
`CellAttributes`	`getBorderControls()` Retrieve the color used by the window movement/sizing controls.
`Screen`	`getScreen()` Get the Screen.
`TStatusBar`	`getStatusBar()` Get the window's status bar, or null if it does not have one.
`java.lang.String`	`getTitle()` Get window title.
`int`	`getZ()` Get Z order.
`boolean`	`hasCloseBox()` Returns true if this window has a close box.
`boolean`	`hasHiddenMouse()` Returns true if this window does not want the application-wide mouse cursor drawn over it.
`boolean`	`hasOverriddenMenu()` Returns true if this window does not want menus to work while it is visible.
`boolean`	`hasZoomBox()` Returns true if this window has a maximize/zoom box.
`void`	`hide()` Hide window.
`boolean`	`inMovements()` See if this window is undergoing any movement/resize/etc.
`boolean`	`isHidden()` Returns true if this window is hidden.
`boolean`	`isModal()` Returns true if this window is modal.
`boolean`	`isShortcutKeypress(TKeypress key)` Determine if a keypress is overridden for this window.
`boolean`	`isShown()` Returns true if this window is shown.
`void`	`maximize()` Maximize window.
`protected boolean`	`mouseOnClose()` Returns true if the mouse is currently on the close button.
`protected boolean`	`mouseOnMaximize()` Returns true if the mouse is currently on the maximize/restore button.
`protected boolean`	`mouseOnResize()` Returns true if the mouse is currently on the resizable lower right corner.
`TStatusBar`	`newStatusBar(java.lang.String text)` Set the window's status bar to a new one.
`protected void`	`onClose()` Subclasses should override this method to cleanup resources.
`void`	`onCommand(TCommandEvent command)` Handle posted command events.
`protected void`	`onFocus()` Called by application.switchWindow() when this window gets the focus, and also by application.addWindow().
`protected void`	`onHide()` Called by application.hideWindow().
`void`	`onKeypress(TKeypressEvent keypress)` Handle keystrokes.
`void`	`onMenu(TMenuEvent menu)` Handle posted menu events.
`void`	`onMouseDown(TMouseEvent mouse)` Handle mouse button presses.
`void`	`onMouseMotion(TMouseEvent mouse)` Handle mouse movements.
`void`	`onMouseUp(TMouseEvent mouse)` Handle mouse button releases.
`protected void`	`onPreClose()` Subclasses should override this method to perform any user prompting before they are offscreen.
`void`	`onResize(TResizeEvent resize)` Method that subclasses can override to handle window/screen resize events.
`protected void`	`onShow()` Called by application.showWindow().
`protected void`	`onUnfocus()` Called by application.switchWindow() when another window gets the focus.
`protected void`	`removeShortcutKeypress(TKeypress key)` Remove a keypress to be overridden for this window.
`void`	`restore()` Restore (unmaximize) window.
`void`	`setHiddenMouse(boolean hideMouse)` Set request to prevent the application-wide mouse cursor from being drawn over this window.
`void`	`setMaximumWindowHeight(int maximumWindowHeight)` Set the maximum height for this window.
`void`	`setMaximumWindowWidth(int maximumWindowWidth)` Set the maximum width for this window.
`void`	`setMinimumWindowHeight(int minimumWindowHeight)` Set the minimum height for this window.
`void`	`setMinimumWindowWidth(int minimumWindowWidth)` Set the minimum width for this window.
`void`	`setTitle(java.lang.String title)` Set window title.
`void`	`setZ(int z)` Set Z order.
`void`	`show()` Show window.
`void`	`stopMovements()` Stop any pending movement/resize/etc.
`java.lang.String`	`toString()` Generate a human-readable string for this window.

Methods inherited from class jexer.TWidget
activate, activate, activateAll, addButton, addCalendar, addCheckBox, addComboBox, addDirectoryList, addDirectoryList, addDirectoryList, addDirectoryList, addEditor, addField, addField, addField, addImage, addImage, addLabel, addLabel, addLabel, addLabel, addLabel, addLabel, addList, addList, addList, addList, addPanel, addPasswordField, addPasswordField, addPasswordField, addProgressBar, addRadioGroup, addSpinner, addSplitPane, addTable, addTable, addText, addText, addTreeViewWidget, addTreeViewWidget, compareTo, doRepaint, drawBox, drawBox, drawBoxShadow, fileOpenBox, fileOpenBox, fileOpenBox, fileOpenBox, fileSaveBox, getAbsoluteX, getAbsoluteY, getActiveChild, getAttrXY, getChildren, getCursorAbsoluteX, getCursorAbsoluteY, getCursorX, getCursorY, getHeight, getLayoutManager, getParent, getTheme, getWidth, getWindow, getX, getY, handleEvent, hLineXY, inputBox, inputBox, inputBox, isAbsoluteActive, isActive, isCursorVisible, isDrawable, isEnabled, isVisible, messageBox, messageBox, mouseWouldHit, onIdle, onMouseDoubleClick, putAll, putAttrXY, putAttrXY, putCharXY, putCharXY, putCharXY, putStringXY, putStringXY, remove, remove, remove, remove, removeAll, resetTabOrder, setActive, setCursorVisible, setCursorX, setCursorY, setDimensions, setEnabled, setHeight, setLayoutManager, setParent, setupForTWindow, setVisible, setWidth, setWindow, setX, setY, splitHorizontal, splitVertical, switchWidget, toPrettyString, toPrettyString, vLineXY

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

- Field Detail
  - RESIZABLE
```
public static final int RESIZABLE
```
    Window is resizable (default yes).
    
    See Also:
    
    Constant Field Values
  - MODAL
```
public static final int MODAL
```
    Window is modal (default no).
    
    See Also:
    
    Constant Field Values
  - CENTERED
```
public static final int CENTERED
```
    Window is centered (default no).
    
    See Also:
    
    Constant Field Values
  - NOCLOSEBOX
```
public static final int NOCLOSEBOX
```
    Window has no close box (default no). Window can still be closed via TApplication.closeWindow() and TWindow.close().
    
    See Also:
    
    Constant Field Values
  - NOZOOMBOX
```
public static final int NOZOOMBOX
```
    Window has no maximize box (default no).
    
    See Also:
    
    Constant Field Values
  - ABSOLUTEXY
```
public static final int ABSOLUTEXY
```
    Window is placed at absolute position (no smart placement) (default no).
    
    See Also:
    
    Constant Field Values
  - HIDEONCLOSE
```
public static final int HIDEONCLOSE
```
    Hitting the closebox with the mouse calls TApplication.hideWindow() rather than TApplication.closeWindow() (default no).
    
    See Also:
    
    Constant Field Values
  - OVERRIDEMENU
```
public static final int OVERRIDEMENU
```
    Menus cannot be used when this window is active (default no).
    
    See Also:
    
    Constant Field Values
  - inWindowMove
```
protected boolean inWindowMove
```
    If true, then the user clicked on the title bar and is moving the window.
  - inWindowResize
```
protected boolean inWindowResize
```
    If true, then the user clicked on the bottom right corner and is resizing the window.
  - inKeyboardResize
```
protected boolean inKeyboardResize
```
    If true, then the user selected "Size/Move" (or hit Ctrl-F5) and is resizing/moving the window via the keyboard.
  - mouse
```
protected TMouseEvent mouse
```
    Remember mouse state.
  - statusBar
```
protected TStatusBar statusBar
```
    A window may have a status bar associated with it. TApplication will draw this status bar last, and will also route events to it first before the window.
- Constructor Detail
  - TWindow
```
public TWindow(TApplication application,
               java.lang.String title,
               int width,
               int height)
```
    Public constructor. Window will be located at (0, 0).
    
    Parameters:
    
    application - TApplication that manages this window
    
    title - window title, will be centered along the top border
    
    width - width of window
    
    height - height of window
  - TWindow
```
public TWindow(TApplication application,
               java.lang.String title,
               int width,
               int height,
               int flags)
```
    Public constructor. Window will be located at (0, 0).
    
    Parameters:
    
    application - TApplication that manages this window
    
    title - window title, will be centered along the top border
    
    width - width of window
    
    height - height of window
    
    flags - bitmask of RESIZABLE, CENTERED, or MODAL
  - TWindow
```
public TWindow(TApplication application,
               java.lang.String title,
               int x,
               int y,
               int width,
               int height)
```
    Public constructor.
    
    Parameters:
    
    application - TApplication that manages this window
    
    title - window title, will be centered along the top border
    
    x - column relative to parent
    
    y - row relative to parent
    
    width - width of window
    
    height - height of window
  - TWindow
```
public TWindow(TApplication application,
               java.lang.String title,
               int x,
               int y,
               int width,
               int height,
               int flags)
```
    Public constructor.
    
    Parameters:
    
    application - TApplication that manages this window
    
    title - window title, will be centered along the top border
    
    x - column relative to parent
    
    y - row relative to parent
    
    width - width of window
    
    height - height of window
    
    flags - mask of RESIZABLE, CENTERED, or MODAL
- Method Detail
  - mouseOnClose
```
protected boolean mouseOnClose()
```
    Returns true if the mouse is currently on the close button.
    
    Returns:
    
    true if mouse is currently on the close button
  - mouseOnMaximize
```
protected boolean mouseOnMaximize()
```
    Returns true if the mouse is currently on the maximize/restore button.
    
    Returns:
    
    true if the mouse is currently on the maximize/restore button
  - mouseOnResize
```
protected boolean mouseOnResize()
```
    Returns true if the mouse is currently on the resizable lower right corner.
    
    Returns:
    
    true if the mouse is currently on the resizable lower right corner
  - onPreClose
```
protected void onPreClose()
```
    Subclasses should override this method to perform any user prompting before they are offscreen. Note that unlike other windowing toolkits, windows can NOT use this function in some manner to avoid being closed. This is called by application.closeWindow().
  - onClose
```
protected void onClose()
```
    Subclasses should override this method to cleanup resources. This is called by application.closeWindow().
  - onFocus
```
protected void onFocus()
```
    Called by application.switchWindow() when this window gets the focus, and also by application.addWindow().
  - onUnfocus
```
protected void onUnfocus()
```
    Called by application.switchWindow() when another window gets the focus.
  - onHide
```
protected void onHide()
```
    Called by application.hideWindow().
  - onShow
```
protected void onShow()
```
    Called by application.showWindow().
  - onMouseDown
```
public void onMouseDown(TMouseEvent mouse)
```
    Handle mouse button presses.
    
    Overrides:
    
    onMouseDown in class TWidget
    
    Parameters:
    
    mouse - mouse button event
  - onMouseUp
```
public void onMouseUp(TMouseEvent mouse)
```
    Handle mouse button releases.
    
    Overrides:
    
    onMouseUp in class TWidget
    
    Parameters:
    
    mouse - mouse button release event
  - onMouseMotion
```
public void onMouseMotion(TMouseEvent mouse)
```
    Handle mouse movements.
    
    Overrides:
    
    onMouseMotion in class TWidget
    
    Parameters:
    
    mouse - mouse motion event
  - onKeypress
```
public void onKeypress(TKeypressEvent keypress)
```
    Handle keystrokes.
    
    Overrides:
    
    onKeypress in class TWidget
    
    Parameters:
    
    keypress - keystroke event
  - onCommand
```
public void onCommand(TCommandEvent command)
```
    Handle posted command events.
    
    Overrides:
    
    onCommand in class TWidget
    
    Parameters:
    
    command - command event
  - onMenu
```
public void onMenu(TMenuEvent menu)
```
    Handle posted menu events.
    
    Overrides:
    
    onMenu in class TWidget
    
    Parameters:
    
    menu - menu event
  - onResize
```
public void onResize(TResizeEvent resize)
```
    Method that subclasses can override to handle window/screen resize events.
    
    Overrides:
    
    onResize in class TWidget
    
    Parameters:
    
    resize - resize event
  - getApplication
```
public final TApplication getApplication()
```
    Get this TWindow's parent TApplication.
    
    Overrides:
    
    getApplication in class TWidget
    
    Returns:
    
    this TWindow's parent TApplication
  - getScreen
```
public final Screen getScreen()
```
    Get the Screen.
    
    Overrides:
    
    getScreen in class TWidget
    
    Returns:
    
    the Screen
  - draw
```
public void draw()
```
    Called by TApplication.drawChildren() to render on screen.
    
    Overrides:
    
    draw in class TWidget
  - getTitle
```
public final java.lang.String getTitle()
```
    Get window title.
    
    Returns:
    
    window title
  - setTitle
```
public final void setTitle(java.lang.String title)
```
    Set window title.
    
    Parameters:
    
    title - new window title
  - getZ
```
public final int getZ()
```
    Get Z order. Lower number means more in-front.
    
    Returns:
    
    Z value. Lower number means more in-front.
  - setZ
```
public final void setZ(int z)
```
    Set Z order. Lower number means more in-front.
    
    Parameters:
    
    z - the new Z value. Lower number means more in-front.
  - addShortcutKeypress
```
protected void addShortcutKeypress(TKeypress key)
```
    Add a keypress to be overridden for this window.
    
    Parameters:
    
    key - the key to start taking control of
  - removeShortcutKeypress
```
protected void removeShortcutKeypress(TKeypress key)
```
    Remove a keypress to be overridden for this window.
    
    Parameters:
    
    key - the key to stop taking control of
  - clearShortcutKeypresses
```
protected void clearShortcutKeypresses()
```
    Remove all keypresses to be overridden for this window.
  - isShortcutKeypress
```
public boolean isShortcutKeypress(TKeypress key)
```
    Determine if a keypress is overridden for this window.
    
    Parameters:
    
    key - the key to check
    
    Returns:
    
    true if this window wants to process this key on its own
  - getStatusBar
```
public TStatusBar getStatusBar()
```
    Get the window's status bar, or null if it does not have one.
    
    Returns:
    
    the status bar, or null
  - newStatusBar
```
public TStatusBar newStatusBar(java.lang.String text)
```
    Set the window's status bar to a new one.
    
    Parameters:
    
    text - the status bar text
    
    Returns:
    
    the status bar
  - setMaximumWindowWidth
```
public final void setMaximumWindowWidth(int maximumWindowWidth)
```
    Set the maximum width for this window.
    
    Parameters:
    
    maximumWindowWidth - new maximum width
  - setMinimumWindowWidth
```
public final void setMinimumWindowWidth(int minimumWindowWidth)
```
    Set the minimum width for this window.
    
    Parameters:
    
    minimumWindowWidth - new minimum width
  - setMaximumWindowHeight
```
public final void setMaximumWindowHeight(int maximumWindowHeight)
```
    Set the maximum height for this window.
    
    Parameters:
    
    maximumWindowHeight - new maximum height
  - setMinimumWindowHeight
```
public final void setMinimumWindowHeight(int minimumWindowHeight)
```
    Set the minimum height for this window.
    
    Parameters:
    
    minimumWindowHeight - new minimum height
  - center
```
public final void center()
```
    Recenter the window on-screen.
  - maximize
```
public void maximize()
```
    Maximize window.
  - restore
```
public void restore()
```
    Restore (unmaximize) window.
  - isHidden
```
public final boolean isHidden()
```
    Returns true if this window is hidden.
    
    Returns:
    
    true if this window is hidden, false if the window is shown
  - isShown
```
public final boolean isShown()
```
    Returns true if this window is shown.
    
    Returns:
    
    true if this window is shown, false if the window is hidden
  - hide
```
public void hide()
```
    Hide window. A hidden window will still have its onIdle() called, and will also have onClose() called at application exit. Hidden windows will not receive any other events.
  - show
```
public void show()
```
    Show window.
  - activate
```
public void activate()
```
    Activate window (bring to top and receive events).
    
    Overrides:
    
    activate in class TWidget
  - close
```
public void close()
```
    Close window. Note that windows without a close box can still be closed by calling the close() method.
    
    Overrides:
    
    close in class TWidget
  - inMovements
```
public boolean inMovements()
```
    See if this window is undergoing any movement/resize/etc.
    
    Returns:
    
    true if the window is moving
  - stopMovements
```
public void stopMovements()
```
    Stop any pending movement/resize/etc.
  - isModal
```
public final boolean isModal()
```
    Returns true if this window is modal.
    
    Returns:
    
    true if this window is modal
  - hasCloseBox
```
public final boolean hasCloseBox()
```
    Returns true if this window has a close box.
    
    Returns:
    
    true if this window has a close box
  - hasZoomBox
```
public final boolean hasZoomBox()
```
    Returns true if this window has a maximize/zoom box.
    
    Returns:
    
    true if this window has a maximize/zoom box
  - hasOverriddenMenu
```
public final boolean hasOverriddenMenu()
```
    Returns true if this window does not want menus to work while it is visible.
    
    Returns:
    
    true if this window does not want menus to work while it is visible
  - getBackground
```
public CellAttributes getBackground()
```
    Retrieve the background color.
    
    Returns:
    
    the background color
  - getBorder
```
public CellAttributes getBorder()
```
    Retrieve the border color.
    
    Returns:
    
    the border color
  - getBorderControls
```
public CellAttributes getBorderControls()
```
    Retrieve the color used by the window movement/sizing controls.
    
    Returns:
    
    the color used by the zoom box, resize bar, and close box
  - hasHiddenMouse
```
public boolean hasHiddenMouse()
```
    Returns true if this window does not want the application-wide mouse cursor drawn over it.
    
    Returns:
    
    true if this window does not want the application-wide mouse cursor drawn over it
  - setHiddenMouse
```
public final void setHiddenMouse(boolean hideMouse)
```
    Set request to prevent the application-wide mouse cursor from being drawn over this window.
    
    Parameters:
    
    hideMouse - if true, this window does not want the application-wide mouse cursor drawn over it
  - toString
```
public java.lang.String toString()
```
    Generate a human-readable string for this window.
    
    Overrides:
    
    toString in class TWidget
    
    Returns:
    
    a human-readable string

Class TWindow

Field Summary

Constructor Summary

Method Summary

Methods inherited from class jexer.TWidget

Methods inherited from class java.lang.Object

Field Detail

RESIZABLE

MODAL

CENTERED

NOCLOSEBOX

NOZOOMBOX

ABSOLUTEXY

HIDEONCLOSE

OVERRIDEMENU

inWindowMove

inWindowResize

inKeyboardResize

mouse

statusBar

Constructor Detail

TWindow

TWindow

TWindow

TWindow

Method Detail

mouseOnClose

mouseOnMaximize

mouseOnResize

onPreClose

onClose

onFocus

onUnfocus

onHide

onShow

onMouseDown

onMouseUp

onMouseMotion

onKeypress

onCommand

onMenu

onResize

getApplication

getScreen

draw

getTitle

setTitle

getZ

setZ

addShortcutKeypress

removeShortcutKeypress

clearShortcutKeypresses

isShortcutKeypress

getStatusBar

newStatusBar

setMaximumWindowWidth

setMinimumWindowWidth

setMaximumWindowHeight

setMinimumWindowHeight

center

maximize

restore

isHidden

isShown

hide

show

activate

close

inMovements

stopMovements

isModal

hasCloseBox

hasZoomBox

hasOverriddenMenu

getBackground

getBorder

getBorderControls

hasHiddenMouse

setHiddenMouse

toString