Package snap.view

Class WindowView

java.lang.Object

snap.props.PropObject

snap.view.View

snap.view.ParentView

snap.view.WindowView

All Implemented Interfaces:

PropChange.DoChange, XMLArchiver.Archivable

Direct Known Subclasses:

PopupWindow

public class WindowView
extends ParentView

A class to manage a Window.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	WindowView.Style
static class	WindowView.WindowHpr<T>	A class to map snap Window functionality to native platform.

Field Summary

Fields

Modifier and Type	Field	Description
protected WindowView.WindowHpr	_helper
static final String	ActiveCursor_Prop
static final String	AlwaysOnTop_Prop
static final String	Image_Prop
static final String	Maximized_Prop
static final String	Resizable_Prop
static final String	Title_Prop
static final String	TYPE_MAIN
static final String	TYPE_PLAIN
static final String	TYPE_UTILITY

Fields inherited from class snap.view.ParentView

_children, Child_Prop, NeedsLayout_Prop

Fields inherited from class snap.view.View

_align, _borderRadius, _effect, _font, _margin, _padding, _repaintRect, _showing, _spacing, _vertical, Action, Align_Prop, Border_Prop, BorderRadius_Prop, Clip_Prop, Cursor_Prop, DEFAULT_ALIGN, DEFAULT_MARGIN, DEFAULT_PADDING, DEFAULT_SPACING, Disabled_Prop, DragEvents, Effect_Prop, Fill_Prop, Focusable_Prop, Focused_Prop, FocusWhenPressed_Prop, Font_Prop, GrowHeight_Prop, GrowWidth_Prop, Height_Prop, KeyEvents, KeyPress, KeyRelease, KeyType, LeanX_Prop, LeanY_Prop, Margin_Prop, MaxHeight_Prop, MaxWidth_Prop, MinHeight_Prop, MinWidth_Prop, MouseDrag, MouseEnter, MouseEvents, MouseExit, MouseMove, MousePress, MouseRelease, Name_Prop, Opacity_Prop, Padding_Prop, Paintable_Prop, Parent_Prop, Pickable_Prop, PrefHeight_Prop, PrefWidth_Prop, Rotate_Prop, ScaleX_Prop, ScaleY_Prop, Scroll, Showing_Prop, Spacing_Prop, Text_Prop, ToolTip_Prop, TransX_Prop, TransY_Prop, Vertical_Prop, Visible_Prop, Width_Prop, X_Prop, Y_Prop

Fields inherited from class snap.props.PropObject

_pcs, EMPTY_OBJECT

Constructor Summary

Constructors

Constructor	Description
WindowView()	Creates a WindowView.

Method Summary

Modifier and Type	Method	Description
void	dispatchEventToWindow(ViewEvent anEvent)	Dispatch event.
Cursor	getActiveCursor()	Returns the active cursor.
View	getClientView()	Returns the view associated with the last show() call.
View	getContent()	Returns the content associated with this window.
Object	getContentNative()	Returns the native for the window content.
EventDispatcher	getDispatcher()	Returns the EventDispatcher.
WebURL	getDocURL()	Returns the document file URL for the window title bar proxy icon.
View	getFocusedView()	Returns the view that currently receives KeyEvents.
View	getFocusedViewLast()	Returns the previous focus view.
WindowView.WindowHpr	getHelper()	Returns the view helper.
Image	getImage()	Returns the icon image for the window.
Rect	getMaximizedBounds()	Returns the window max size.
static <T extends ViewOwner> T	getOpenWindowOwner(Class<T> aClass)	Returns an array of all open windows.
static <T extends ViewOwner> T[]	getOpenWindowOwners(Class<T> aClass)	Returns an array of all open windows.
static WindowView[]	getOpenWindows()	Returns an array of all open windows.
PopupWindow	getPopup()	Returns the popup window, if one was added to root view during last event.
protected double	getPrefHeightImpl(double aW)	Returns the preferred height.
protected double	getPrefWidthImpl(double aH)	Returns the preferred width.
RootView	getRootView()	Returns the root view.
String	getSaveName()	Returns the save name.
Point	getScreenLocation(View aView, Pos aPos, double aDX, double aDY)	Returns the screen location for given view, position and offsets.
String	getTitle()	Returns the title of the window.
String	getToolTip(ViewEvent anEvent)	Override to try to get tool tip from mouse over stack.
String	getType()	Returns the window type.
ViewUpdater	getUpdater()	Returns the Updater.
WindowView	getWindow()	Override to return this window.
void	hide()	Hide the window.
protected void	initNativeWindow()	Initializes the native window.
boolean	isAlwaysOnTop()	Returns whether the window is always on top.
boolean	isHideOnDeactivate()	Returns whether the window will hide on deactivate.
boolean	isMaximized()	Returns whether the window is sized to maximum screen size.
boolean	isModal()	Returns the modal mode of the window.
boolean	isResizable()	Returns whether the window is resizable.
boolean	isSaveSize()	Returns whether to save size
boolean	isVisible()	Override to return showing, since it is eqivalent for window.
protected void	layoutImpl()	Layout children.
void	pack()	Packs the window.
void	relayout()	Override to do layout immediately.
void	repaint(double aX, double aY, double aW, double aH)	Override to change to root view.
protected void	requestFocus(View aView)	Tries to makes the given view the view that receives KeyEvents.
void	resetActiveCursor()	Resets the active cursor.
void	saveFrame()	Save frame.
void	setActiveCursor(Cursor aCursor)	Sets the current cursor.
void	setAlwaysOnTop(boolean aValue)	Sets whether the window is always on top.
void	setContent(View aView)	Sets the content associated with this window.
void	setDocURL(WebURL aURL)	Returns the document file URL for the window title bar proxy icon.
protected void	setFocused(boolean aValue)	Override to move window to front of all windows list.
void	setHideOnDeactivate(boolean aValue)	Sets whether the window will hide on deacativate.
void	setImage(Image anImage)	Sets the icon image for the window.
void	setMaximized(boolean aValue)	Sets whether the window is sized to maximum screen size.
void	setMaximizedBounds(Rect aRect)	Sets the bounds rect to use when window is maximized (uses ViewEnv ScreenBoundsInset by default).
void	setModal(boolean aValue)	Sets the modal mode of the window (defaults to false).
protected void	setPopup(PopupWindow aPopup)	Sets the popup window, if one added to this root view during last event.
void	setResizable(boolean aValue)	Sets whether the window is resizable (default to true).
void	setSaveName(String aName)	Sets the save name.
void	setSaveSize(boolean aValue)	Sets whether to save size.
protected void	setShowing(boolean aValue)	Override to update global windows list.
void	setTitle(String aValue)	Sets the title of the window.
void	setType(String aType)	Sets the window type.
void	setVisible(boolean aValue)	Override to call show/hide.
void	show()	Shows window in center of screen.
void	show(View aView, double aX, double aY)	Show the window relative to given view and View X/Y (screen x/y if view is null).
void	showCentered(View aView)	Shows window in center of given view.
void	toFront()	Order window to front.

Methods inherited from class snap.view.ParentView

addChild, addChild, addDeepChangeListener, childDidDeepChange, childDidPropChange, fromXML, fromXMLChildren, fromXMLView, getChild, getChildAt, getChildAt, getChildCount, getChildCountManaged, getChildForClass, getChildForName, getChildLast, getChildren, getChildrenForClass, getChildrenManaged, getFocusNext, getFocusPrev, getPropValue, getViewList, getViewProxy, indexOfChild, initProps, intersects, isInLayout, isNeedsLayout, isNeedsLayoutDeep, isNeedsRepaintDeep, layout, layoutDeep, layoutDeepImpl, layoutFloatingViews, paintAbove, paintAll, paintChildren, parentFontChanged, processPropChange, removeChild, removeChild, removeChildren, removeDeepChangeListener, setChildren, setFont, setNeedsLayout, setNeedsLayoutDeep, setNeedsRepaintDeep, setOwner, setOwnerChildren, setPropValue, themeChanged, toXML, toXMLChildren, toXMLView

Methods inherited from class snap.view.View

addBinding, addEventFilter, addEventHandler, clone, contains, contains, contains, disableEvents, dispatchEventToView, enableEvents, fireActionEvent, getAlign, getAlignX, getAlignY, getAnim, getAnimCleared, getAnimTimeDeep, getBestHeight, getBestSize, getBestWidth, getBinding, getBinding, getBindingCount, getBindings, getBorder, getBorderRadius, getBounds, getBoundsLocal, getBoundsParent, getBoundsShape, getBoundsShapeParent, getClip, getClipAll, getClipAllBounds, getClipBounds, getClippedRect, getCursor, getDefaultBorder, getDefaultFill, getDefaultFont, getEffect, getEnv, getEventAdapter, getFill, getFillColor, getFocusNext, getFocusPrev, getFont, getHeight, getHost, getInsetsAll, getLean, getLeanX, getLeanY, getLocalToParent, getLocalToParent, getMargin, getMaxHeight, getMaxSize, getMaxWidth, getMaxX, getMaxY, getMidX, getMidY, getMinHeight, getMinHeightImpl, getMinSize, getMinWidth, getMinWidthImpl, getName, getOpacity, getOpacityAll, getOwner, getOwner, getPadding, getParent, getParent, getParentCount, getParentToLocal, getParentToLocal, getPhysics, getPhysics, getPrefHeight, getPrefHeight, getPrefSize, getPrefWidth, getPrefWidth, getProp, getPropDefault, getProps, getRealClassName, getRepaintRect, getRepaintRectExpanded, getRotate, getScale, getScaleX, getScaleY, getSize, getSpacing, getText, getToolTip, getTransX, getTransY, getValuePropName, getVisRect, getWidth, getX, getXY, getY, indexInHost, indexInParent, isActionable, isAncestor, isClipToBounds, isDisabled, isEnabled, isFocusable, isFocused, isFocusKeysEnabled, isFocusPainted, isFocusWhenPressed, isFontSet, isGrowHeight, isGrowWidth, isGuest, isHorizontal, isLocalToParentSimple, isManaged, isManagedVisible, isMaxHeightSet, isMaxWidthSet, isMinHeightSet, isMinWidthSet, isMouseDown, isMouseOver, isNeedsRepaint, isPaintable, isPickable, isPickableVisible, isPrefHeightSet, isPrefWidthSet, isShowing, isToolTipEnabled, isVertical, localToParent, localToParent, localToParent, localToParent, localToScreen, paintBack, paintFront, parentToLocal, parentToLocal, parentToLocal, parentToLocal, playAnimDeep, processEvent, processEventFilters, processEventHandlers, relayoutParent, removeBinding, removeBinding, removeEventFilter, removeEventHandler, repaint, repaint, repaintInParent, requestFocus, scrollToVisible, setActionable, setAlign, setAlignX, setAlignY, setAnimTimeDeep, setBorder, setBorder, setBorderRadius, setBounds, setBounds, setBoundsLocal, setClip, setClipToBounds, setCursor, setDisabled, setEffect, setEnabled, setFill, setFocusable, setFocusKeysEnabled, setFocusPainted, setFocusWhenPressed, setGrowHeight, setGrowWidth, setHeight, setLean, setLeanX, setLeanY, setManaged, setMargin, setMargin, setMaxHeight, setMaxSize, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinSize, setMinWidth, setName, setOpacity, setPadding, setPadding, setPaintable, setParent, setPickable, setPrefHeight, setPrefSize, setPrefSize, setPrefWidth, setProp, setRealClassName, setRotate, setScale, setScaleX, setScaleY, setSize, setSize, setSizeLocal, setSizeToPrefSize, setSpacing, setText, setToolTip, setToolTipEnabled, setTransX, setTransY, setVertical, setWidth, setX, setXY, setXYLocal, setY, stopAnimDeep, toStringProps

Methods inherited from class snap.props.PropObject

addPropChangeListener, addPropChangeListener, firePropChange, firePropChange, firePropChange, getPropForName, getPropParent, getPropSet, getPropsForArchival, getPropsForArchivalExtra, isPropDefault, removePropChangeListener, removePropChangeListener, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_helper

protected WindowView.WindowHpr _helper

TYPE_MAIN

public static final String TYPE_MAIN

See Also:

• Constant Field Values

TYPE_UTILITY

public static final String TYPE_UTILITY

See Also:

• Constant Field Values

TYPE_PLAIN

public static final String TYPE_PLAIN

See Also:

• Constant Field Values

ActiveCursor_Prop

public static final String ActiveCursor_Prop

See Also:

• Constant Field Values

AlwaysOnTop_Prop

public static final String AlwaysOnTop_Prop

See Also:

• Constant Field Values

Image_Prop

public static final String Image_Prop

See Also:

• Constant Field Values

Maximized_Prop

public static final String Maximized_Prop

See Also:

• Constant Field Values

Resizable_Prop

public static final String Resizable_Prop

See Also:

• Constant Field Values

Title_Prop

public static final String Title_Prop

See Also:

• Constant Field Values

Constructor Details

WindowView

public WindowView()

Creates a WindowView.

Method Details

getTitle

public String getTitle()

Returns the title of the window.

setTitle

public void setTitle(String aValue)

Sets the title of the window.

getType

public String getType()

Returns the window type.

setType

public void setType(String aType)

Sets the window type.

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).

isMaximized

public boolean isMaximized()

Returns whether the window is sized to maximum screen size.

setMaximized

public void setMaximized(boolean aValue)

Sets whether the window is sized to maximum screen size.

getMaximizedBounds

public Rect getMaximizedBounds()

Returns the window max size.

setMaximizedBounds

public void setMaximizedBounds(Rect aRect)

Sets the bounds rect to use when window is maximized (uses ViewEnv ScreenBoundsInset by default).

getSaveName

public String getSaveName()

Returns the save name.

setSaveName

public void setSaveName(String aName)

Sets the save name.

isSaveSize

public boolean isSaveSize()

Returns whether to save size

setSaveSize

public void setSaveSize(boolean aValue)

Sets whether to save size.

saveFrame

public void saveFrame()

Save frame.

getRootView

public RootView getRootView()

Returns the root view.

Overrides:

getRootView in class View

getContent

public View getContent()

Returns the content associated with this window.

setContent

public void setContent(View aView)

Sets the content associated with this window.

getContentNative

public Object getContentNative()

Returns the native for the window content.

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.

getDocURL

public WebURL getDocURL()

Returns the document file URL for the window title bar proxy icon.

setDocURL

public void setDocURL(WebURL aURL)

Returns the document file URL for the window title bar proxy icon.

getImage

public Image getImage()

Returns the icon image for the window.

setImage

public void setImage(Image anImage)

Sets the icon image for the window.

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.

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).

getFocusedView

public View getFocusedView()

Returns the view that currently receives KeyEvents.

getFocusedViewLast

public View getFocusedViewLast()

Returns the previous focus view.

requestFocus

protected void requestFocus(View aView)

Tries to makes the given view the view that receives KeyEvents.

getHelper

public WindowView.WindowHpr getHelper()

Returns the view helper.

initNativeWindow

protected void initNativeWindow()

Initializes the native window.

showCentered

public void showCentered(View aView)

Shows window in center of given view.

show

public void show(View aView,
 double aX,
 double aY)

Show the window relative to given view and View X/Y (screen x/y if view is null).

show

public void show()

Shows window in center of screen.

hide

public void hide()

Hide the window.

getClientView

public View getClientView()

Returns the view associated with the last show() call.

pack

public void pack()

Packs the window.

toFront

public void toFront()

Order window to front.

getScreenLocation

public Point getScreenLocation(View aView,
 Pos aPos,
 double aDX,
 double aDY)

Returns the screen location for given view, position and offsets.

getWindow

public WindowView getWindow()

Override to return this window.

Overrides:

getWindow in class View

relayout

public void relayout()

Override to do layout immediately.

Overrides:

relayout in class ParentView

repaint

public void repaint(double aX,
 double aY,
 double aW,
 double aH)

Override to change to root view.

Overrides:

repaint in class View

isVisible

public boolean isVisible()

Override to return showing, since it is eqivalent for window.

Overrides:

isVisible in class View

setVisible

public void setVisible(boolean aValue)

Override to call show/hide.

Overrides:

setVisible in class View

setShowing

protected void setShowing(boolean aValue)

Override to update global windows list.

Overrides:

setShowing in class ParentView

setFocused

protected void setFocused(boolean aValue)

Override to move window to front of all windows list.

Overrides:

setFocused in class View

getActiveCursor

public Cursor getActiveCursor()

Returns the active cursor.

setActiveCursor

public void setActiveCursor(Cursor aCursor)

Sets the current cursor.

resetActiveCursor

public void resetActiveCursor()

Resets the active cursor.

getToolTip

public String getToolTip(ViewEvent anEvent)

Override to try to get tool tip from mouse over stack.

Overrides:

getToolTip in class View

getDispatcher

public EventDispatcher getDispatcher()

Returns the EventDispatcher.

dispatchEventToWindow

public void dispatchEventToWindow(ViewEvent anEvent)

Dispatch event.

getUpdater

public ViewUpdater getUpdater()

Returns the Updater.

Overrides:

getUpdater in class View

getPopup

public PopupWindow getPopup()

Returns the popup window, if one was added to root view during last event.

setPopup

protected void setPopup(PopupWindow aPopup)

Sets the popup window, if one added to this root view during last event.

getPrefWidthImpl

protected double getPrefWidthImpl(double aH)

Returns the preferred width.

Overrides:

getPrefWidthImpl in class View

getPrefHeightImpl

protected double getPrefHeightImpl(double aW)

Returns the preferred height.

Overrides:

getPrefHeightImpl in class View

layoutImpl

protected void layoutImpl()

Layout children.

Overrides:

layoutImpl in class ParentView

getOpenWindows

public static WindowView[] getOpenWindows()

Returns an array of all open windows.

getOpenWindowOwner

public static <T extends ViewOwner> T getOpenWindowOwner(Class<T> aClass)

Returns an array of all open windows.

getOpenWindowOwners

public static <T extends ViewOwner> T[] getOpenWindowOwners(Class<T> aClass)

Returns an array of all open windows.