|
NextApp Echo3 v3.0.b4 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object nextapp.echo.app.Component nextapp.echo.app.WindowPane
public class WindowPane
WindowPane component: displays content in a movable and/or resizable window. May only be added to a ContentPane
. May
contain at most one child component. May contain Pane
s as children.
Field Summary | |
---|---|
static int |
DISPOSE_ON_CLOSE
A constant for the defaultCloseOperation property
indicating that a window should be removed from the component
hierarchy when a user attempts to close it. |
static int |
DO_NOTHING_ON_CLOSE
A constant for the defaultCloseOperation property
indicating that nothing should be done when the user attempts
to close a window. |
static int |
HIDE_ON_CLOSE
A constant for the defaultCloseOperation property
indicating that a window should be hidden when the user attempts
to close it. |
static java.lang.String |
INPUT_CLOSE
|
static java.lang.String |
PROPERTY_BACKGROUND_IMAGE
|
static java.lang.String |
PROPERTY_BORDER
|
static java.lang.String |
PROPERTY_CLOSABLE
|
static java.lang.String |
PROPERTY_CLOSE_ICON
|
static java.lang.String |
PROPERTY_CLOSE_ICON_INSETS
|
static java.lang.String |
PROPERTY_CLOSE_ROLLOVER_ICON
|
static java.lang.String |
PROPERTY_CONTENT_HEIGHT
|
static java.lang.String |
PROPERTY_CONTENT_WIDTH
|
static java.lang.String |
PROPERTY_CONTROLS_INSETS
|
static java.lang.String |
PROPERTY_CONTROLS_SPACING
|
static java.lang.String |
PROPERTY_DEFAULT_CLOSE_OPERATION
|
static java.lang.String |
PROPERTY_HEIGHT
|
static java.lang.String |
PROPERTY_ICON
|
static java.lang.String |
PROPERTY_ICON_INSETS
|
static java.lang.String |
PROPERTY_INSETS
|
static java.lang.String |
PROPERTY_MAXIMIZE_ENABLED
|
static java.lang.String |
PROPERTY_MAXIMIZE_ICON
|
static java.lang.String |
PROPERTY_MAXIMIZE_ICON_INSETS
|
static java.lang.String |
PROPERTY_MAXIMIZE_ROLLOVER_ICON
|
static java.lang.String |
PROPERTY_MAXIMUM_HEIGHT
|
static java.lang.String |
PROPERTY_MAXIMUM_WIDTH
|
static java.lang.String |
PROPERTY_MINIMIZE_ENABLED
|
static java.lang.String |
PROPERTY_MINIMIZE_ICON
|
static java.lang.String |
PROPERTY_MINIMIZE_ICON_INSETS
|
static java.lang.String |
PROPERTY_MINIMIZE_ROLLOVER_ICON
|
static java.lang.String |
PROPERTY_MINIMUM_HEIGHT
|
static java.lang.String |
PROPERTY_MINIMUM_WIDTH
|
static java.lang.String |
PROPERTY_MOVABLE
|
static java.lang.String |
PROPERTY_POSITION_X
|
static java.lang.String |
PROPERTY_POSITION_Y
|
static java.lang.String |
PROPERTY_RESIZABLE
|
static java.lang.String |
PROPERTY_TITLE
|
static java.lang.String |
PROPERTY_TITLE_BACKGROUND
|
static java.lang.String |
PROPERTY_TITLE_BACKGROUND_IMAGE
|
static java.lang.String |
PROPERTY_TITLE_FONT
|
static java.lang.String |
PROPERTY_TITLE_FOREGROUND
|
static java.lang.String |
PROPERTY_TITLE_HEIGHT
|
static java.lang.String |
PROPERTY_TITLE_INSETS
|
static java.lang.String |
PROPERTY_WIDTH
|
static java.lang.String |
PROPERTY_Z_INDEX
|
static java.lang.String |
Z_INDEX_CHANGED_PROPERTY
Deprecated. Will be removed prior to 3.0. |
Fields inherited from interface nextapp.echo.app.ModalSupport |
---|
MODAL_CHANGED_PROPERTY |
Constructor Summary | |
---|---|
WindowPane()
Creates a new WindowPane . |
|
WindowPane(java.lang.String title,
Extent width,
Extent height)
Creates a new WindowPane with the specified title
and dimensions. |
Method Summary | |
---|---|
void |
addWindowPaneListener(WindowPaneListener l)
Adds a WindowPaneListener to receive event notifications. |
protected void |
fireWindowClosing()
Notifies WindowPaneListener s that the user has requested
to close this WindowPane . |
FillImage |
getBackgroundImage()
Returns the background image of the WindowPane . |
FillImageBorder |
getBorder()
Returns the border which surrounds the entire WindowPane . |
ImageReference |
getCloseIcon()
Returns the close button icon. |
Insets |
getCloseIconInsets()
Returns the inset margin around the close button icon. |
ImageReference |
getCloseRolloverIcon()
Returns the close button rollover icon. |
Extent |
getContentHeight()
Returns the configured height of the content region of the window. |
Extent |
getContentWidth()
Returns the configured width of the content region of the window. |
Insets |
getControlsInsets()
Returns the inset margin around the window controls (e.g., close, minimize, and maximize buttons) |
Extent |
getControlsSpacing()
Returns the spacing between the window control icons (e.g., close, minimize, and maximize buttons). |
int |
getDefaultCloseOperation()
Returns the default close operation. |
Extent |
getHeight()
Returns the configured height of the overall window, including its border. |
ImageReference |
getIcon()
Returns the icon displayed in the title region. |
Insets |
getIconInsets()
Returns the inset margin around the icon. |
Insets |
getInsets()
Returns the inset of the window content. |
ImageReference |
getMaximizeIcon()
Returns the maximize button icon. |
Insets |
getMaximizeIconInsets()
Returns the inset margin around the maximize button icon. |
ImageReference |
getMaximizeRolloverIcon()
Returns the maximize button rollover icon. |
Extent |
getMaximumHeight()
Returns the maximum height of the content region of the WindowPane . |
Extent |
getMaximumWidth()
Returns the maximum width of the content region of the WindowPane . |
ImageReference |
getMinimizeIcon()
Returns the minimize button icon. |
Insets |
getMinimizeIconInsets()
Returns the inset margin around the minimize button icon. |
ImageReference |
getMinimizeRolloverIcon()
Returns the minimize button rollover icon. |
Extent |
getMinimumHeight()
Returns the minimum height of the content region of the WindowPane . |
Extent |
getMinimumWidth()
Returns the minimum width of the content region of the WindowPane . |
Extent |
getPositionX()
Returns the horizontal (Y) position of the WindowPane with
respect to its container. |
Extent |
getPositionY()
Returns the vertical (Y) position of the WindowPane with
respect to its container. |
java.lang.String |
getTitle()
Returns the title of the WindowPane . |
Color |
getTitleBackground()
Returns the background color of the title region. |
FillImage |
getTitleBackgroundImage()
Returns the background image of the title region. |
Font |
getTitleFont()
Returns the font of the title region. |
Color |
getTitleForeground()
Returns the foreground color of the title region. |
Extent |
getTitleHeight()
Returns the height of the title region. |
Insets |
getTitleInsets()
Returns the insets of the title region. |
Extent |
getWidth()
Returns the configured width of the overall window, including its border. |
int |
getZIndex()
Returns the z-index of the window with respect to its parent ContentPane . |
boolean |
isClosable()
Determines if the window is closable via a provided close button in the title bar. |
boolean |
isMaximizeEnabled()
Determines if the window can be maximized via a provided close button in the title bar. |
boolean |
isMinimizeEnabled()
Determines if the window can be minimized via a provided close button in the title bar. |
boolean |
isModal()
Determines the modal state of this component. |
boolean |
isMovable()
Determines if the window is movable. |
boolean |
isResizable()
Determines if the window is resizable. |
boolean |
isValidChild(Component component)
Limit content to a single child. |
boolean |
isValidParent(Component parent)
Only allow ContentPane s as parents. |
void |
processInput(java.lang.String inputName,
java.lang.Object inputValue)
Processes client input specific to the Component
received from the UpdateManager . |
void |
removeWindowPaneListener(WindowPaneListener l)
Removes a WindowPaneListener from receiving event notifications. |
void |
setBackgroundImage(FillImage newValue)
Sets the background image of the WindowPane . |
void |
setBorder(FillImageBorder newValue)
Sets the border which surrounds the entire WindowPane . |
void |
setClosable(boolean newValue)
Sets whether the window is closable via a provided close button in the title bar. |
void |
setCloseIcon(ImageReference newValue)
Sets the close button icon. |
void |
setCloseIconInsets(Insets newValue)
Sets the inset margin around the close button icon. |
void |
setCloseRolloverIcon(ImageReference newValue)
Sets the close button rollover icon. |
void |
setContentHeight(Extent newValue)
Sets the content height of the WindowPane . |
void |
setContentWidth(Extent newValue)
Sets the content width of the WindowPane . |
void |
setControlsInsets(Extent newValue)
Sets the inset margin around the window controls (e.g., close, minimize, and maximize buttons). |
void |
setControlsSpacing(Extent newValue)
Sets the spacing between the window control icons (e.g., close, minimize, and maximize buttons). |
void |
setDefaultCloseOperation(int newValue)
Sets the default close operation. |
void |
setHeight(Extent newValue)
Sets the overall height of the WindowPane , including its border. |
void |
setIcon(ImageReference newValue)
Sets the icon displayed in the title region. |
void |
setIconInsets(Insets newValue)
Sets the inset margin around the icon. |
void |
setInsets(Insets newValue)
Sets the inset of the window content. |
void |
setMaximizeEnabled(boolean newValue)
Sets whether the window can be maximized via a provided button in the title bar. |
void |
setMaximizeIcon(ImageReference newValue)
Sets the maximize button icon. |
void |
setMaximizeIconInsets(Insets newValue)
Sets the inset margin around the maximize button icon. |
void |
setMaximizeRolloverIcon(ImageReference newValue)
Sets the maximize button rollover icon. |
void |
setMaximumHeight(Extent newValue)
Sets the maximum height of the content region of the WindowPane . |
void |
setMaximumWidth(Extent newValue)
Sets the maximum width of the content region of the WindowPane . |
void |
setMinimizeEnabled(boolean newValue)
Sets whether the window can be minimized via a provided button in the title bar. |
void |
setMinimizeIcon(ImageReference newValue)
Sets the minimize button icon. |
void |
setMinimizeIconInsets(Insets newValue)
Sets the inset margin around the minimize button icon. |
void |
setMinimizeRolloverIcon(ImageReference newValue)
Sets the minimize button rollover icon. |
void |
setMinimumHeight(Extent newValue)
Sets the minimum height of the content region of the WindowPane . |
void |
setMinimumWidth(Extent newValue)
Sets the minimum width of the content region of the WindowPane . |
void |
setModal(boolean newValue)
Sets the modal state of the Component . |
void |
setMovable(boolean newValue)
Sets whether the window is movable. |
void |
setPositionX(Extent newValue)
Sets the horizontal (X) position of the WindowPane with
respect to its container. |
void |
setPositionY(Extent newValue)
Sets the vertical (Y) position of the WindowPane with
respect to its container. |
void |
setResizable(boolean newValue)
Sets whether the window is resizable. |
void |
setTitle(java.lang.String newValue)
Sets the title of the WindowPane . |
void |
setTitleBackground(Color newValue)
Sets the background color of the title region. |
void |
setTitleBackgroundImage(FillImage newValue)
Sets the background image of the title region. |
void |
setTitleFont(Font newValue)
Sets the font of the title region. |
void |
setTitleForeground(Color newValue)
Sets the foreground color of the title region. |
void |
setTitleHeight(Extent newValue)
Sets the height of the title region. |
void |
setTitleInsets(Insets newValue)
Sets the insets of the title region. |
void |
setWidth(Extent newValue)
Sets the overall width of the WindowPane , including its border. |
void |
setZIndex(int newValue)
Sets the z-index of the window with respect to its parent ContentPane . |
void |
userClose()
Processes a user request to close the window (via the close button). |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String INPUT_CLOSE
public static final java.lang.String PROPERTY_BACKGROUND_IMAGE
public static final java.lang.String PROPERTY_BORDER
public static final java.lang.String PROPERTY_CLOSABLE
public static final java.lang.String PROPERTY_CLOSE_ICON
public static final java.lang.String PROPERTY_CLOSE_ICON_INSETS
public static final java.lang.String PROPERTY_CLOSE_ROLLOVER_ICON
public static final java.lang.String PROPERTY_CONTENT_HEIGHT
public static final java.lang.String PROPERTY_CONTENT_WIDTH
public static final java.lang.String PROPERTY_CONTROLS_INSETS
public static final java.lang.String PROPERTY_CONTROLS_SPACING
public static final java.lang.String PROPERTY_DEFAULT_CLOSE_OPERATION
public static final java.lang.String PROPERTY_HEIGHT
public static final java.lang.String PROPERTY_ICON
public static final java.lang.String PROPERTY_ICON_INSETS
public static final java.lang.String PROPERTY_INSETS
public static final java.lang.String PROPERTY_MAXIMIZE_ENABLED
public static final java.lang.String PROPERTY_MAXIMIZE_ICON
public static final java.lang.String PROPERTY_MAXIMIZE_ICON_INSETS
public static final java.lang.String PROPERTY_MAXIMIZE_ROLLOVER_ICON
public static final java.lang.String PROPERTY_MAXIMUM_HEIGHT
public static final java.lang.String PROPERTY_MAXIMUM_WIDTH
public static final java.lang.String PROPERTY_MINIMIZE_ENABLED
public static final java.lang.String PROPERTY_MINIMIZE_ICON
public static final java.lang.String PROPERTY_MINIMIZE_ICON_INSETS
public static final java.lang.String PROPERTY_MINIMIZE_ROLLOVER_ICON
public static final java.lang.String PROPERTY_MINIMUM_HEIGHT
public static final java.lang.String PROPERTY_MINIMUM_WIDTH
public static final java.lang.String PROPERTY_MOVABLE
public static final java.lang.String PROPERTY_POSITION_X
public static final java.lang.String PROPERTY_POSITION_Y
public static final java.lang.String PROPERTY_RESIZABLE
public static final java.lang.String PROPERTY_TITLE
public static final java.lang.String PROPERTY_TITLE_BACKGROUND
public static final java.lang.String PROPERTY_TITLE_BACKGROUND_IMAGE
public static final java.lang.String PROPERTY_TITLE_FONT
public static final java.lang.String PROPERTY_TITLE_FOREGROUND
public static final java.lang.String PROPERTY_TITLE_HEIGHT
public static final java.lang.String PROPERTY_TITLE_INSETS
public static final java.lang.String PROPERTY_WIDTH
public static final java.lang.String PROPERTY_Z_INDEX
public static final java.lang.String Z_INDEX_CHANGED_PROPERTY
PROPERTY_Z_INDEX
,
Constant Field Valuespublic static final int DO_NOTHING_ON_CLOSE
defaultCloseOperation
property
indicating that nothing should be done when the user attempts
to close a window.
public static final int HIDE_ON_CLOSE
defaultCloseOperation
property
indicating that a window should be hidden when the user attempts
to close it.
public static final int DISPOSE_ON_CLOSE
defaultCloseOperation
property
indicating that a window should be removed from the component
hierarchy when a user attempts to close it.
Constructor Detail |
---|
public WindowPane()
WindowPane
.
public WindowPane(java.lang.String title, Extent width, Extent height)
WindowPane
with the specified title
and dimensions.
title
- the titlewidth
- The widthheight
- The heightMethod Detail |
---|
public void addWindowPaneListener(WindowPaneListener l)
WindowPaneListener
to receive event notifications.
l
- the WindowPaneListener
to addprotected void fireWindowClosing()
WindowPaneListener
s that the user has requested
to close this WindowPane
.
public FillImage getBackgroundImage()
WindowPane
.
public FillImageBorder getBorder()
WindowPane
.
public ImageReference getCloseIcon()
public Insets getCloseIconInsets()
public ImageReference getCloseRolloverIcon()
public Extent getContentHeight()
public Extent getContentWidth()
public Extent getControlsSpacing()
public Insets getControlsInsets()
public int getDefaultCloseOperation()
public Extent getHeight()
public ImageReference getIcon()
public Insets getIconInsets()
public Insets getInsets()
Pane
component.
public ImageReference getMaximizeIcon()
public Insets getMaximizeIconInsets()
public ImageReference getMaximizeRolloverIcon()
public Extent getMaximumHeight()
WindowPane
.
public Extent getMaximumWidth()
WindowPane
.
public ImageReference getMinimizeIcon()
public Insets getMinimizeIconInsets()
public ImageReference getMinimizeRolloverIcon()
public Extent getMinimumHeight()
WindowPane
.
public Extent getMinimumWidth()
WindowPane
.
public Extent getPositionX()
WindowPane
with
respect to its container.
public Extent getPositionY()
WindowPane
with
respect to its container.
public java.lang.String getTitle()
WindowPane
.
public Color getTitleBackground()
public FillImage getTitleBackgroundImage()
public Font getTitleFont()
public Color getTitleForeground()
public Extent getTitleHeight()
public Insets getTitleInsets()
public Extent getWidth()
public int getZIndex()
ContentPane
. Windows with higher z-indices will
visually obscure windows with lower z-indices.
public boolean isClosable()
public boolean isMaximizeEnabled()
public boolean isMinimizeEnabled()
public boolean isModal()
ModalSupport
isModal
in interface ModalSupport
ModalSupport.isModal()
public boolean isMovable()
public boolean isResizable()
public boolean isValidChild(Component component)
isValidChild
in class Component
component
- the Component
to evaluate as a child
Component
is a valid childComponent.isValidChild(nextapp.echo.app.Component)
public boolean isValidParent(Component parent)
ContentPane
s as parents.
isValidParent
in class Component
parent
- the Component
to evaluate as a parent
Component
is a valid parentComponent.isValidParent(nextapp.echo.app.Component)
public void processInput(java.lang.String inputName, java.lang.Object inputValue)
Component
Component
received from the UpdateManager
.
Derivative implementations should take care to invoke
super.processInput()
.
Security note: Because input to this method is
likely from a remote client, it should be treated as potentially hostile.
All input to this method should be carefully verified.
For example, directly invoking set()
method with the
provided input would constitute a security hole.
processInput
in class Component
inputName
- the name of the inputinputValue
- the value of the inputComponent.processInput(java.lang.String, java.lang.Object)
public void removeWindowPaneListener(WindowPaneListener l)
WindowPaneListener
from receiving event notifications.
l
- the WindowPaneListener
to removepublic void setBackgroundImage(FillImage newValue)
WindowPane
.
newValue
- the new background imagepublic void setBorder(FillImageBorder newValue)
WindowPane
.
newValue
- the new borderpublic void setClosable(boolean newValue)
newValue
- true if the window is closablepublic void setCloseIcon(ImageReference newValue)
newValue
- the new iconpublic void setCloseIconInsets(Insets newValue)
newValue
- the new inset marginpublic void setCloseRolloverIcon(ImageReference newValue)
newValue
- the new iconpublic void setContentHeight(Extent newValue)
WindowPane
.
This value will be overridden by the height
property, if it is set.
newValue
- the new content heightpublic void setContentWidth(Extent newValue)
WindowPane
.
This value will be overridden by the width
property, if it is set.
newValue
- the new content widthpublic void setControlsSpacing(Extent newValue)
newValue
- the new controls spacingpublic void setControlsInsets(Extent newValue)
newValue
- the new inset marginpublic void setDefaultCloseOperation(int newValue)
newValue
- the new default close operation, one of the following
values:
public void setHeight(Extent newValue)
WindowPane
, including its border.
This value will override any setting of the contentHeight
property.
newValue
- the new heightpublic void setIcon(ImageReference newValue)
newValue
- the new iconpublic void setIconInsets(Insets newValue)
newValue
- the new inset marginpublic void setInsets(Insets newValue)
Pane
component.
newValue
- the new insetpublic void setMaximizeEnabled(boolean newValue)
newValue
- true if the window can be maximizedpublic void setMaximizeIcon(ImageReference newValue)
newValue
- the new iconpublic void setMaximizeIconInsets(Insets newValue)
newValue
- the new inset marginpublic void setMaximizeRolloverIcon(ImageReference newValue)
newValue
- the new iconpublic void setMaximumHeight(Extent newValue)
WindowPane
.
newValue
- the new maximum heightpublic void setMaximumWidth(Extent newValue)
WindowPane
.
newValue
- the new maximum widthpublic void setMinimizeEnabled(boolean newValue)
newValue
- true if the window can be minimizedpublic void setMinimizeIcon(ImageReference newValue)
newValue
- the new iconpublic void setMinimizeIconInsets(Insets newValue)
newValue
- the new inset marginpublic void setMinimizeRolloverIcon(ImageReference newValue)
newValue
- the new iconpublic void setMinimumHeight(Extent newValue)
WindowPane
.
newValue
- the new minimum heightpublic void setMinimumWidth(Extent newValue)
WindowPane
.
newValue
- the new minimum widthpublic void setModal(boolean newValue)
ModalSupport
Component
.
setModal
in interface ModalSupport
newValue
- the new modal stateModalSupport.setModal(boolean)
public void setMovable(boolean newValue)
newValue
- true if the window may be moved by the userpublic void setPositionX(Extent newValue)
WindowPane
with
respect to its container.
newValue
- the new positionpublic void setPositionY(Extent newValue)
WindowPane
with
respect to its container.
newValue
- the new positionpublic void setResizable(boolean newValue)
newValue
- true if the window may be resized by the userpublic void setTitle(java.lang.String newValue)
WindowPane
.
newValue
- the titlepublic void setTitleFont(Font newValue)
newValue
- the new fontpublic void setTitleBackground(Color newValue)
newValue
- the new colorpublic void setTitleBackgroundImage(FillImage newValue)
newValue
- the new background imagepublic void setTitleForeground(Color newValue)
newValue
- the new colorpublic void setTitleHeight(Extent newValue)
newValue
- the new heightpublic void setTitleInsets(Insets newValue)
newValue
- the new insetspublic void setWidth(Extent newValue)
WindowPane
, including its border.
This value will override any setting of the contentWidth
property.
newValue
- the new widthpublic void setZIndex(int newValue)
ContentPane
. Windows with higher z-indices will
visually obscure windows with lower z-indices.
newValue
- the new z-indexpublic void userClose()
|
NextApp Echo3 v3.0.b4 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |