KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > nextapp > echo2 > webcontainer > command > BrowserOpenWindowCommand


1 /*
2  * This file is part of the Echo Web Application Framework (hereinafter "Echo").
3  * Copyright (C) 2002-2005 NextApp, Inc.
4  *
5  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
6  *
7  * The contents of this file are subject to the Mozilla Public License Version
8  * 1.1 (the "License"); you may not use this file except in compliance with
9  * the License. You may obtain a copy of the License at
10  * http://www.mozilla.org/MPL/
11  *
12  * Software distributed under the License is distributed on an "AS IS" basis,
13  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
14  * for the specific language governing rights and limitations under the
15  * License.
16  *
17  * Alternatively, the contents of this file may be used under the terms of
18  * either the GNU General Public License Version 2 or later (the "GPL"), or
19  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
20  * in which case the provisions of the GPL or the LGPL are applicable instead
21  * of those above. If you wish to allow use of your version of this file only
22  * under the terms of either the GPL or the LGPL, and not to allow others to
23  * use your version of this file under the terms of the MPL, indicate your
24  * decision by deleting the provisions above and replace them with the notice
25  * and other provisions required by the GPL or the LGPL. If you do not delete
26  * the provisions above, a recipient may use your version of this file under
27  * the terms of any one of the MPL, the GPL or the LGPL.
28  */
29
30 package nextapp.echo2.webcontainer.command;
31
32 import nextapp.echo2.app.Command;
33
34 /**
35  * A Web Application Container-specific <code>Command</code> to
36  * open a new browser window displaying a specific URI.
37  * This action may not be performed on a client if the client has
38  * pop-up blocking enabled.
39  */
40 public class BrowserOpenWindowCommand
41 implements Command {
42     
43     private String JavaDoc uri;
44     private String JavaDoc features;
45     private String JavaDoc name;
46     private boolean replace;
47     
48     /**
49      * Creates a new <code>BrowserOpenWindowCommand</code>.
50      *
51      * @param uri the target URI
52      * @param name the window name (may be null)
53      * @param features the 'features' string which will be used to configure the
54      * new browser window (may be null)
55      */
56     public BrowserOpenWindowCommand(String JavaDoc uri, String JavaDoc name, String JavaDoc features) {
57         this(uri, name, features, false);
58     }
59     
60     /**
61      * Creates a new <code>BrowserOpenWindowCommand</code>.
62      *
63      * @param uri the target URI
64      * @param name the window name (may be null)
65      * @param features the 'features' string which will be used to configure the
66      * new browser window (may be null)
67      * @param replace a flag indicating whether the new URI should replace the
68      * previous URI in the window's history. This flag is only relevant
69      * when using this command to replace a browser window.
70      */
71     public BrowserOpenWindowCommand(String JavaDoc uri, String JavaDoc name, String JavaDoc features, boolean replace) {
72         super();
73         this.uri = uri;
74         this.name = name;
75         this.features = features;
76     }
77     
78     /**
79      * Returns the 'features' string which will be used to configure the
80      * new browser window.
81      *
82      * @return features the 'features' string
83      */
84     public String JavaDoc getFeatures() {
85         return features;
86     }
87
88     /**
89      * Returns the window name.
90      *
91      * @return the window name
92      */
93     public String JavaDoc getName() {
94         return name;
95     }
96     
97     /**
98      * Returns the target URI.
99      *
100      * @return the target URI
101      */
102     public String JavaDoc getUri() {
103         return uri;
104     }
105     
106     /**
107      * Determines if the new URI should replace the old one in the history.
108      *
109      * @return true if the new URI should replace the old one in the history
110      */
111     public boolean isReplace() {
112         return replace;
113     }
114 }
115
Popular Tags