org.fujion.component

Class Window

java.lang.Object

org.fujion.component.BaseComponent

org.fujion.component.BaseUIComponent

org.fujion.component.Window

All Implemented Interfaces:

IDisable, IElementIdentifier, INamespace, IClientTransform

@Component(tag="window",
           widgetClass="Window",
           content=AS_CHILD,
           parentTag="*",
           childTag=@Component.ChildTag(value="*"),
           description="A window component with a title bar and maximize/minimize/close buttons.")
public class Window
extends BaseUIComponent
implements INamespace

A window component with a title bar and maximize/minimize/close buttons. May be used in modal, popup, or inline modes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Window.CloseAction Action upon window closure.
static class	Window.Mode Possible display modes for a window.
static class	Window.Position Placement of window in view port when first displayed.
static class	Window.Size Size state for a window.

Nested classes/interfaces inherited from class org.fujion.component.BaseComponent

BaseComponent.SubComponent

Field Summary

Fields inherited from interface org.fujion.ancillary.IElementIdentifier

log

Constructor Summary

Constructors

Constructor and Description
Window()

Method Summary

Modifier and Type	Method and Description
boolean	canClose() Invokes the canClose logic and returns the result.
boolean	close() Request the window to be closed.
Window.CloseAction	getCloseAction() Returns the action to be taken when the window is closed.
String	getImage() Returns the URL of the image to be displayed on the left side of the title bar.
Window.Mode	getMode() Returns the display mode of the window.
BooleanSupplier	getOnCanClose() Returns the functional interface that determines whether window closure is permitted.
Window.Position	getPosition() Returns the placement of a newly opened modal or popup window.
Window.Size	getSize() Returns the sizing mode of the window.
String	getTitle() Returns the title text.
boolean	isClosable() Returns true if the window is closable.
boolean	isMaximizable() Returns true if the window may be maximized.
boolean	isMinimizable() Returns true if the window may be minimized.
boolean	isMovable() Returns whether the window may be moved to a new position by dragging its title bar.
boolean	isSizable() Returns the window's sizable property.
void	modal() Opens the window modally.
void	modal(IEventListener closeListener) Opens the window modally.
void	popup() Opens the window as a popup.
void	popup(IEventListener closeListener) Opens the window as a popup.
void	setClosable(boolean closable) Set to true to make the window closable.
void	setCloseAction(Window.CloseAction closeAction) Sets the action to be taken when the window is closed.
void	setImage(String image) Sets the URL of the image to be displayed on the left side of the title bar.
void	setMaximizable(boolean maximizable) Sets whether the window may be maximized.
void	setMinimizable(boolean minimizable) Sets whether the window may be minimized.
void	setMode(Window.Mode mode) Sets the display mode of the window.
void	setMovable(boolean movable) Sets whether the window may be moved to a new position by dragging its title bar.
void	setOnCanClose(boolean canClose) Sets whether window closure is permitted using a simple Boolean value.
void	setOnCanClose(BooleanSupplier onCanClose) Sets the functional interface that will determine if window closure is permitted.
void	setPosition(Window.Position position) Sets the placement of a newly opened modal or popup window.
void	setSizable(boolean sizable) Sets the window's sizable property.
void	setSize(Window.Size size) Sets the sizing mode of the window.
void	setTitle(String title) Sets the title text.

Methods inherited from class org.fujion.component.BaseUIComponent

_syncClasses, _syncStyles, addClass, addMask, addMask, addMask, addStyle, addStyles, afterRemoveChild, focus, getBalloon, getClasses, getContext, getCss, getDragid, getDropid, getFirstVisibleChild, getFirstVisibleChild, getFlex, getHeight, getHint, getKeycapture, getPopup, getStyle, getStyles, getTabindex, getWidth, hide, isDisabled, isVisible, onDestroyTracked, print, print, removeClass, removeMask, removeStyle, reportSize, scrollIntoView, setBalloon, setClasses, setContext, setCss, setDisabled, setDragid, setDropid, setFlex, setFocus, setHeight, setHint, setKeycapture, setPopup, setStyles, setTabindex, setVisible, setWidth, show, toggleClass

Methods inherited from class org.fujion.component.BaseComponent

_attach, _getChildren, _initProps, addChild, addChild, addChild, addChildren, addEventForward, addEventForward, addEventForward, addEventForward, addEventListener, addEventListener, addEventListener, addEventListener, addSnippet, afterAddChild, afterSetParent, areEqual, beforeAddChild, beforeRemoveChild, beforeSetParent, bind, bringToFront, defaultify, destroy, destroyChildren, detach, finalize, findAllNamed, findAttribute, findByName, findByName, findChildByData, findChildByLabel, fireEvent, fireEvent, fireEventToClient, fireEventToClient, getAncestor, getAncestor, getAttribute, getAttribute, getAttribute, getAttributes, getChild, getChildAt, getChildCount, getChildCount, getChildren, getChildren, getContent, getController, getControllers, getData, getData, getDefinition, getFirstChild, getId, getIndex, getLastChild, getName, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, hasAttribute, hasChildren, hasEventListener, hasEventListener, invoke, invoke, invoke, invoke, invokeIfAttached, isAncestor, isContainer, isContentSynced, isDead, isNamespace, isRendered, notifyAncestors, notifyDescendants, nullify, onAttach, onDestroy, propertyChange, removeAttribute, removeChild, removeEventForward, removeEventForward, removeEventForward, removeEventForward, removeEventListener, removeEventListener, removeEventListener, removeEventListener, setAttribute, setContent, setContentSynced, setData, setIndex, setName, setNamespace, setParent, sub, swapChildren, swapTrackedComponents, sync, toString, trackComponent, trimify, untrackComponent, validate, validate, validateChild, validateIsChild, validateName, validatePage, validateParent, wireController

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.fujion.ancillary.IElementIdentifier

transformForClient

Constructor Detail

Window

public Window()

Method Detail

getTitle

@Component.PropertyGetter(value="title",
                          description="The title text.")
public String getTitle()

Returns the title text.

Returns:

The title text.

setTitle

@Component.PropertySetter(value="title",
                          description="The title text.")
public void setTitle(String title)

Sets the title text.

Parameters:

title - The title text.

getImage

@Component.PropertyGetter(value="image",
                          description="The URL of the image to be displayed on the left side of the title bar.")
public String getImage()

Returns the URL of the image to be displayed on the left side of the title bar.

Returns:

The URL of the image to be displayed on the left side of the title bar.

setImage

@Component.PropertySetter(value="image",
                          description="The URL of the image to be displayed on the left side of the title bar.")
public void setImage(String image)

Sets the URL of the image to be displayed on the left side of the title bar.

Parameters:

image - The URL of the image to be displayed on the left side of the title bar.

isClosable

@Component.PropertyGetter(value="closable",
                          description="True if the window is closable. A window that is closable has an icon that, when clicked, triggers a close event.")
public boolean isClosable()

Returns true if the window is closable. A window that is closable has an icon that, when clicked, triggers a close event.

Returns:

True if the window is closable.

setClosable

@Component.PropertySetter(value="closable",
                          defaultValue="false",
                          description="True if the window is closable. A window that is closable has an icon that, when clicked, triggers a close event.")
public void setClosable(boolean closable)

Set to true to make the window closable. A window that is closable has an icon that, when clicked, triggers a close event.

Parameters:

closable - If true, the window is closable.

See Also:

onCanClose

isSizable

@Component.PropertyGetter(value="sizable",
                          description="The window\'s sizable property. A window that is sizable has borders that may be dragged to change its dimensions.")
public boolean isSizable()

Returns the window's sizable property. A window that is sizable has borders that may be dragged to change its dimensions. If the mode is INLINE, this property has no effect.

Returns:

The window's sizable property.

setSizable

@Component.PropertySetter(value="sizable",
                          defaultValue="false",
                          description="The window\'s sizable property. A window that is sizable has borders that may be dragged to change its dimensions.")
public void setSizable(boolean sizable)

Sets the window's sizable property. A window that is sizable has borders that may be dragged to change its dimensions. If the mode is INLINE, this property has no effect.

Parameters:

sizable - The window's sizable property.

getPosition

@Component.PropertyGetter(value="position",
                          description="The placement of a newly opened modal or popup window.")
public Window.Position getPosition()

Returns the placement of a newly opened modal or popup window.

Returns:

The placement of a newly opened modal or popup window.

setPosition

@Component.PropertySetter(value="position",
                          defaultValue="center",
                          description="The placement of a newly opened modal or popup window.")
public void setPosition(Window.Position position)

Sets the placement of a newly opened modal or popup window.

Parameters:

position - The placement of a newly opened modal or popup window.

isMovable

@Component.PropertyGetter(value="movable",
                          description="If true, the window may be moved to a new position by dragging its title bar.")
public boolean isMovable()

Returns whether the window may be moved to a new position by dragging its title bar. If the mode is INLINE, this property has no effect.

Returns:

If true, the window may be moved to a new position by dragging its title bar.

setMovable

@Component.PropertySetter(value="movable",
                          defaultValue="true",
                          description="If true, the window may be moved to a new position by dragging its title bar.")
public void setMovable(boolean movable)

Sets whether the window may be moved to a new position by dragging its title bar. If the mode is INLINE, this property has no effect.

Parameters:

movable - If true, the window may be moved to a new position by dragging its title bar.

isMaximizable

@Component.PropertyGetter(value="maximizable",
                          description="True if the window may be maximized.")
public boolean isMaximizable()

Returns true if the window may be maximized. A window that is maximizable has an icon that, when clicked, causes a modal or popup window to be resized to fill the view port. Clicking the icon again restores the window to its original size and position.

Returns:

True if the window is maximizable.

setMaximizable

@Component.PropertySetter(value="maximizable",
                          defaultValue="false",
                          description="True if the window may be maximized.")
public void setMaximizable(boolean maximizable)

Sets whether the window may be maximized. A window that is maximizable has an icon that, when clicked, causes a modal or popup window to be resized to fill the view port. Clicking the icon again restores the window to its original size and position.

Parameters:

maximizable - True if the window is maximizable.

isMinimizable

@Component.PropertyGetter(value="minimizable",
                          description="True if the window may be minimized.")
public boolean isMinimizable()

Returns true if the window may be minimized. A window that is minimizable has an icon that, when clicked, causes a window's body to be hidden. If the window's mode is modal or popup, it will also be resized to a smaller dimension and placed at the lower left corner of the view port. Clicking the icon again restores the window to its original size and position.

Returns:

True if the window is minimizable.

setMinimizable

@Component.PropertySetter(value="minimizable",
                          defaultValue="false",
                          description="True if the window may be minimized.")
public void setMinimizable(boolean minimizable)

Sets whether the window may be minimized. A window that is minimizable has an icon that, when clicked, causes a window's body to be hidden. If the window's mode is modal or popup, it will also be resized to a smaller dimension and placed at the lower left corner of the view port. Clicking the icon again restores the window to its original size and position.

Parameters:

minimizable - True if the window is minimizable.

getMode

@Component.PropertyGetter(value="mode",
                          description="The display mode of the window.")
public Window.Mode getMode()

Returns the display mode of the window.

Returns:

The display mode of the window.

setMode

@Component.PropertySetter(value="mode",
                          defaultValue="inline",
                          description="The display mode of the window.")
public void setMode(Window.Mode mode)

Sets the display mode of the window.

Parameters:

mode - The display mode of the window.

getSize

@Component.PropertyGetter(value="size",
                          description="The sizing mode of the window.")
public Window.Size getSize()

Returns the sizing mode of the window.

Returns:

The sizing mode of the window.

setSize

@Component.PropertySetter(value="size",
                          defaultValue="normal",
                          description="The sizing mode of the window.")
public void setSize(Window.Size size)

Sets the sizing mode of the window.

Parameters:

size - The sizing mode of the window.

getCloseAction

@Component.PropertyGetter(value="closeAction",
                          description="The action to be taken when the window is closed.")
public Window.CloseAction getCloseAction()

Returns the action to be taken when the window is closed.

Returns:

The action to be taken when the window is closed.

setCloseAction

@Component.PropertySetter(value="closeAction",
                          defaultValue="destroy",
                          description="The action to be taken when the window is closed.")
public void setCloseAction(Window.CloseAction closeAction)

Sets the action to be taken when the window is closed.

Parameters:

closeAction - The action to be taken when the window is closed.

close

public boolean close()

Request the window to be closed. Window closure may be prevented if the onCanClose logic returns false.

Returns:

True if the window was closed.

getOnCanClose

public BooleanSupplier getOnCanClose()

Returns the functional interface that determines whether window closure is permitted.

Returns:

The functional interface that determines whether window closure is permitted.

setOnCanClose

public void setOnCanClose(boolean canClose)

Sets whether window closure is permitted using a simple Boolean value. This is a shortcut for calling setOnCanClose(boolean) with a functional interface that returns a fixed Boolean value.

Parameters:

canClose - If true, the tab may be closed.

setOnCanClose

public void setOnCanClose(BooleanSupplier onCanClose)

Sets the functional interface that will determine if window closure is permitted.

Parameters:

onCanClose - The functional interface that will determine if window closure is permitted.

canClose

public boolean canClose()

Invokes the canClose logic and returns the result.

Returns:

The result of invoking the canClose logic.

modal

public void modal()

Opens the window modally.

modal

public void modal(IEventListener closeListener)

Opens the window modally.

Parameters:

closeListener - The event listener to be invoked upon window closure.

popup

public void popup()

Opens the window as a popup.

popup

public void popup(IEventListener closeListener)

Opens the window as a popup.

Parameters:

closeListener - The event listener to be invoked upon window closure.