nextapp.echo.webcontainer.command
Class BrowserOpenWindowCommand

java.lang.Object
  nextapp.echo.webcontainer.command.BrowserOpenWindowCommand

All Implemented Interfaces:

nextapp.echo.app.Command

public class BrowserOpenWindowCommand
extends java.lang.Object
implements nextapp.echo.app.Command

A Web Application Container-specific Command to open a new browser window displaying a specific URI. This action may not propagate to a client if the client has pop-up blocking algorithm enabled.

Field Summary

static int	FLAG_LOCATION Flag to enable the browser's location input field.
static int	FLAG_MENUBAR Flag to enable the browser's menu bar.
static int	FLAG_REPLACE Flag to replace entry in browser's navigation history with new window content.
static int	FLAG_RESIZABLE Flag to recommend that the browser allow resizing of the window.
static int	FLAG_STATUS Flag to enable the browser's status field.
static int	FLAG_TOOLBAR Flag to enable the browser's tool bar.

Constructor Summary

BrowserOpenWindowCommand(java.lang.String uri, java.lang.String name)
Creates a new BrowserOpenWindowCommand.

BrowserOpenWindowCommand(java.lang.String uri, java.lang.String name, nextapp.echo.app.Extent width, nextapp.echo.app.Extent height, int flags)
Creates a new BrowserOpenWindowCommand.

Method Summary

int	getFlags() Returns the configuration flags, zero or more of the following values ORed together: FLAG_REPLACE FLAG_MENUBAR FLAG_TOOLBAR FLAG_LOCATION FLAG_STATUS FLAG_RESIZABLE
nextapp.echo.app.Extent	getHeight() Returns the height of the window to be opened.
java.lang.String	getName() Returns the window name.
java.lang.String	getUri() Returns the target URI.
nextapp.echo.app.Extent	getWidth() Returns the width of the window to be opened.

Methods inherited from class java.lang.Object

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

Field Detail

FLAG_REPLACE

public static final int FLAG_REPLACE

Flag to replace entry in browser's navigation history with new window content. Note that some browsers may ignore this flag.

See Also:

Constant Field Values

FLAG_MENUBAR

public static final int FLAG_MENUBAR

Flag to enable the browser's menu bar.

See Also:

Constant Field Values

FLAG_TOOLBAR

public static final int FLAG_TOOLBAR

Flag to enable the browser's tool bar.

See Also:

Constant Field Values

FLAG_LOCATION

public static final int FLAG_LOCATION

Flag to enable the browser's location input field.

See Also:

Constant Field Values

FLAG_STATUS

public static final int FLAG_STATUS

Flag to enable the browser's status field.

See Also:

Constant Field Values

FLAG_RESIZABLE

public static final int FLAG_RESIZABLE

Flag to recommend that the browser allow resizing of the window. Some environments may always allow the window to be resized.

See Also:

Constant Field Values

Constructor Detail

BrowserOpenWindowCommand

public BrowserOpenWindowCommand(java.lang.String uri,
                                java.lang.String name)

Creates a new BrowserOpenWindowCommand.

Parameters:

uri - the target URI

name - the window name (may be null)

BrowserOpenWindowCommand

public BrowserOpenWindowCommand(java.lang.String uri,
                                java.lang.String name,
                                nextapp.echo.app.Extent width,
                                nextapp.echo.app.Extent height,
                                int flags)

Creates a new BrowserOpenWindowCommand.

Parameters:

uri - the target URI

name - the window name (may be null)

width - the window width (may be null)

height - the window width (may be null)

flags - the configuration flags, zero or more of the following values ORed together:

• FLAG_REPLACE
• FLAG_MENUBAR
• FLAG_TOOLBAR
• FLAG_LOCATION
• FLAG_STATUS
• FLAG_RESIZABLE

Method Detail

getWidth

public nextapp.echo.app.Extent getWidth()

Returns the width of the window to be opened.

Returns:

the width

getHeight

public nextapp.echo.app.Extent getHeight()

Returns the height of the window to be opened.

Returns:

the height

getName

public java.lang.String getName()

Returns the window name.

Returns:

the window name

getUri

public java.lang.String getUri()

Returns the target URI.

Returns:

the target URI

getFlags

public int getFlags()

Returns the configuration flags, zero or more of the following values ORed together:

• FLAG_REPLACE
• FLAG_MENUBAR
• FLAG_TOOLBAR
• FLAG_LOCATION
• FLAG_STATUS
• FLAG_RESIZABLE

Returns:

the configuration flags