123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209 |
- /*
- * Copyright 2000-2014 Vaadin Ltd.
- *
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not
- * use this file except in compliance with the License. You may obtain a copy of
- * the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- * License for the specific language governing permissions and limitations under
- * the License.
- */
-
- package com.vaadin.ui;
-
- import java.io.Serializable;
- import java.lang.reflect.Method;
- import java.util.Map;
-
- import com.vaadin.event.FieldEvents.BlurEvent;
- import com.vaadin.event.FieldEvents.BlurListener;
- import com.vaadin.event.FieldEvents.BlurNotifier;
- import com.vaadin.event.FieldEvents.FocusEvent;
- import com.vaadin.event.FieldEvents.FocusListener;
- import com.vaadin.event.FieldEvents.FocusNotifier;
- import com.vaadin.event.MouseEvents.ClickEvent;
- import com.vaadin.event.ShortcutAction;
- import com.vaadin.event.ShortcutAction.KeyCode;
- import com.vaadin.event.ShortcutAction.ModifierKey;
- import com.vaadin.event.ShortcutListener;
- import com.vaadin.server.PaintException;
- import com.vaadin.server.PaintTarget;
- import com.vaadin.shared.Connector;
- import com.vaadin.shared.MouseEventDetails;
- import com.vaadin.shared.ui.window.WindowMode;
- import com.vaadin.shared.ui.window.WindowRole;
- import com.vaadin.shared.ui.window.WindowServerRpc;
- import com.vaadin.shared.ui.window.WindowState;
- import com.vaadin.util.ReflectTools;
-
- /**
- * A component that represents a floating popup window that can be added to a
- * {@link UI}. A window is added to a {@code UI} using
- * {@link UI#addWindow(Window)}. </p>
- * <p>
- * The contents of a window is set using {@link #setContent(Component)} or by
- * using the {@link #Window(String, Component)} constructor.
- * </p>
- * <p>
- * A window can be positioned on the screen using absolute coordinates (pixels)
- * or set to be centered using {@link #center()}
- * </p>
- * <p>
- * The caption is displayed in the window header.
- * </p>
- * <p>
- * In Vaadin versions prior to 7.0.0, Window was also used as application level
- * windows. This function is now covered by the {@link UI} class.
- * </p>
- *
- * @author Vaadin Ltd.
- * @since 3.0
- */
- @SuppressWarnings("serial")
- public class Window extends Panel implements FocusNotifier, BlurNotifier,
- LegacyComponent {
-
- private WindowServerRpc rpc = new WindowServerRpc() {
-
- @Override
- public void click(MouseEventDetails mouseDetails) {
- fireEvent(new ClickEvent(Window.this, mouseDetails));
- }
-
- @Override
- public void windowModeChanged(WindowMode newState) {
- setWindowMode(newState);
- }
-
- @Override
- public void windowMoved(int x, int y) {
- if (x != getState(false).positionX) {
- setPositionX(x);
- }
- if (y != getState(false).positionY) {
- setPositionY(y);
- }
- }
- };
-
- /**
- * Creates a new, empty window
- */
- public Window() {
- this("", null);
- }
-
- /**
- * Creates a new, empty window with a given title.
- *
- * @param caption
- * the title of the window.
- */
- public Window(String caption) {
- this(caption, null);
- }
-
- /**
- * Creates a new, empty window with the given content and title.
- *
- * @param caption
- * the title of the window.
- * @param content
- * the contents of the window
- */
- public Window(String caption, Component content) {
- super(caption, content);
- registerRpc(rpc);
- setSizeUndefined();
- }
-
- /* ********************************************************************* */
-
- /*
- * (non-Javadoc)
- *
- * @see com.vaadin.ui.Panel#paintContent(com.vaadin.server.PaintTarget)
- */
-
- @Override
- public synchronized void paintContent(PaintTarget target)
- throws PaintException {
- if (bringToFront != null) {
- target.addAttribute("bringToFront", bringToFront.intValue());
- bringToFront = null;
- }
-
- // Contents of the window panel is painted
- super.paintContent(target);
- }
-
- /*
- * (non-Javadoc)
- *
- * @see
- * com.vaadin.ui.AbstractComponent#setParent(com.vaadin.server.ClientConnector
- * )
- */
- @Override
- public void setParent(HasComponents parent) {
- if (parent == null || parent instanceof UI) {
- super.setParent(parent);
- } else {
- throw new IllegalArgumentException(
- "A Window can only be added to a UI using UI.addWindow(Window window)");
- }
- }
-
- /*
- * (non-Javadoc)
- *
- * @see com.vaadin.ui.Panel#changeVariables(java.lang.Object, java.util.Map)
- */
-
- @Override
- public void changeVariables(Object source, Map<String, Object> variables) {
-
- // TODO Are these for top level windows or sub windows?
- boolean sizeHasChanged = false;
- // size is handled in super class, but resize events only in windows ->
- // so detect if size change occurs before super.changeVariables()
- if (variables.containsKey("height")
- && (getHeightUnits() != Unit.PIXELS || (Integer) variables
- .get("height") != getHeight())) {
- sizeHasChanged = true;
- }
- if (variables.containsKey("width")
- && (getWidthUnits() != Unit.PIXELS || (Integer) variables
- .get("width") != getWidth())) {
- sizeHasChanged = true;
- }
-
- super.changeVariables(source, variables);
-
- // Positioning
- final Integer positionx = (Integer) variables.get("positionx");
- if (positionx != null) {
- final int x = positionx.intValue();
- // This is information from the client so it is already using the
- // position. No need to repaint.
- setPositionX(x < 0 ? -1 : x);
- }
- final Integer positiony = (Integer) variables.get("positiony");
- if (positiony != null) {
- final int y = positiony.intValue();
- // This is information from the client so it is already using the
- // position. No need to repaint.
- setPositionY(y < 0 ? -1 : y);
- }
-
- if (isClosable()) {
- // Closing
- final Boolean close = (Boolean) variables.get("close");
- if (close != null && close.booleanValue()) {
- close();
- }
- }
-
- // fire event if size has really changed
- if (sizeHasChanged) {
- fireResize();
- }
-
- if (variables.containsKey(FocusEvent.EVENT_ID)) {
- fireEvent(new FocusEvent(this));
- } else if (variables.containsKey(BlurEvent.EVENT_ID)) {
- fireEvent(new BlurEvent(this));
- }
-
- }
-
- /**
- * Method that handles window closing (from UI).
- *
- * <p>
- * By default, windows are removed from their respective UIs and thus
- * visually closed on browser-side.
- * </p>
- *
- * <p>
- * To react to a window being closed (after it is closed), register a
- * {@link CloseListener}.
- * </p>
- */
- public void close() {
- UI uI = getUI();
-
- // Don't do anything if not attached to a UI
- if (uI != null) {
- // window is removed from the UI
- uI.removeWindow(this);
- }
- }
-
- /**
- * Gets the distance of Window left border in pixels from left border of the
- * containing (main window) when the window is in {@link WindowMode#NORMAL}.
- *
- * @return the Distance of Window left border in pixels from left border of
- * the containing (main window).or -1 if unspecified
- * @since 4.0.0
- */
- public int getPositionX() {
- return getState(false).positionX;
- }
-
- /**
- * Sets the distance of Window left border in pixels from left border of the
- * containing (main window). Has effect only if in {@link WindowMode#NORMAL}
- * mode.
- *
- * @param positionX
- * the Distance of Window left border in pixels from left border
- * of the containing (main window). or -1 if unspecified.
- * @since 4.0.0
- */
- public void setPositionX(int positionX) {
- getState().positionX = positionX;
- getState().centered = false;
- }
-
- /**
- * Gets the distance of Window top border in pixels from top border of the
- * containing (main window) when the window is in {@link WindowMode#NORMAL}
- * state, or when next set to that state.
- *
- * @return Distance of Window top border in pixels from top border of the
- * containing (main window). or -1 if unspecified
- *
- * @since 4.0.0
- */
- public int getPositionY() {
- return getState(false).positionY;
- }
-
- /**
- * Sets the distance of Window top border in pixels from top border of the
- * containing (main window). Has effect only if in {@link WindowMode#NORMAL}
- * mode.
- *
- * @param positionY
- * the Distance of Window top border in pixels from top border of
- * the containing (main window). or -1 if unspecified
- *
- * @since 4.0.0
- */
- public void setPositionY(int positionY) {
- getState().positionY = positionY;
- getState().centered = false;
- }
-
- private static final Method WINDOW_CLOSE_METHOD;
- static {
- try {
- WINDOW_CLOSE_METHOD = CloseListener.class.getDeclaredMethod(
- "windowClose", new Class[] { CloseEvent.class });
- } catch (final java.lang.NoSuchMethodException e) {
- // This should never happen
- throw new java.lang.RuntimeException(
- "Internal error, window close method not found");
- }
- }
-
- public static class CloseEvent extends Component.Event {
-
- /**
- *
- * @param source
- */
- public CloseEvent(Component source) {
- super(source);
- }
-
- /**
- * Gets the Window.
- *
- * @return the window.
- */
- public Window getWindow() {
- return (Window) getSource();
- }
- }
-
- /**
- * An interface used for listening to Window close events. Add the
- * CloseListener to a window and
- * {@link CloseListener#windowClose(CloseEvent)} will be called whenever the
- * user closes the window.
- *
- * <p>
- * Since Vaadin 6.5, removing a window using {@link #removeWindow(Window)}
- * fires the CloseListener.
- * </p>
- */
- public interface CloseListener extends Serializable {
- /**
- * Called when the user closes a window. Use
- * {@link CloseEvent#getWindow()} to get a reference to the
- * {@link Window} that was closed.
- *
- * @param e
- * Event containing
- */
- public void windowClose(CloseEvent e);
- }
-
- /**
- * Adds a CloseListener to the window.
- *
- * For a window the CloseListener is fired when the user closes it (clicks
- * on the close button).
- *
- * For a browser level window the CloseListener is fired when the browser
- * level window is closed. Note that closing a browser level window does not
- * mean it will be destroyed. Also note that Opera does not send events like
- * all other browsers and therefore the close listener might not be called
- * if Opera is used.
- *
- * <p>
- * Since Vaadin 6.5, removing windows using {@link #removeWindow(Window)}
- * does fire the CloseListener.
- * </p>
- *
- * @param listener
- * the CloseListener to add.
- */
- public void addCloseListener(CloseListener listener) {
- addListener(CloseEvent.class, listener, WINDOW_CLOSE_METHOD);
- }
-
- /**
- * @deprecated As of 7.0, replaced by
- * {@link #addCloseListener(CloseListener)}
- **/
- @Deprecated
- public void addListener(CloseListener listener) {
- addCloseListener(listener);
- }
-
- /**
- * Removes the CloseListener from the window.
- *
- * <p>
- * For more information on CloseListeners see {@link CloseListener}.
- * </p>
- *
- * @param listener
- * the CloseListener to remove.
- */
- public void removeCloseListener(CloseListener listener) {
- removeListener(CloseEvent.class, listener, WINDOW_CLOSE_METHOD);
- }
-
- /**
- * @deprecated As of 7.0, replaced by
- * {@link #removeCloseListener(CloseListener)}
- **/
- @Deprecated
- public void removeListener(CloseListener listener) {
- removeCloseListener(listener);
- }
-
- protected void fireClose() {
- fireEvent(new Window.CloseEvent(this));
- }
-
- /**
- * Event which is fired when the mode of the Window changes.
- *
- * @author Vaadin Ltd
- * @since 7.1
- *
- */
- public static class WindowModeChangeEvent extends Component.Event {
-
- private final WindowMode windowMode;
-
- /**
- *
- * @param source
- */
- public WindowModeChangeEvent(Component source, WindowMode windowMode) {
- super(source);
- this.windowMode = windowMode;
- }
-
- /**
- * Gets the Window.
- *
- * @return the window
- */
- public Window getWindow() {
- return (Window) getSource();
- }
-
- /**
- * Gets the new window mode.
- *
- * @return the new mode
- */
- public WindowMode getWindowMode() {
- return windowMode;
- }
- }
-
- /**
- * An interface used for listening to Window maximize / restore events. Add
- * the WindowModeChangeListener to a window and
- * {@link WindowModeChangeListener#windowModeChanged(WindowModeChangeEvent)}
- * will be called whenever the window is maximized (
- * {@link WindowMode#MAXIMIZED}) or restored ({@link WindowMode#NORMAL} ).
- */
- public interface WindowModeChangeListener extends Serializable {
-
- public static final Method windowModeChangeMethod = ReflectTools
- .findMethod(WindowModeChangeListener.class,
- "windowModeChanged", WindowModeChangeEvent.class);
-
- /**
- * Called when the user maximizes / restores a window. Use
- * {@link WindowModeChangeEvent#getWindow()} to get a reference to the
- * {@link Window} that was maximized / restored. Use
- * {@link WindowModeChangeEvent#getWindowMode()} to get a reference to
- * the new state.
- *
- * @param event
- */
- public void windowModeChanged(WindowModeChangeEvent event);
- }
-
- /**
- * Adds a WindowModeChangeListener to the window.
- *
- * The WindowModeChangeEvent is fired when the user changed the display
- * state by clicking the maximize/restore button or by double clicking on
- * the window header. The event is also fired if the state is changed using
- * {@link #setWindowMode(WindowMode)}.
- *
- * @param listener
- * the WindowModeChangeListener to add.
- */
- public void addWindowModeChangeListener(WindowModeChangeListener listener) {
- addListener(WindowModeChangeEvent.class, listener,
- WindowModeChangeListener.windowModeChangeMethod);
- }
-
- /**
- * Removes the WindowModeChangeListener from the window.
- *
- * @param listener
- * the WindowModeChangeListener to remove.
- */
- public void removeWindowModeChangeListener(WindowModeChangeListener listener) {
- removeListener(WindowModeChangeEvent.class, listener,
- WindowModeChangeListener.windowModeChangeMethod);
- }
-
- protected void fireWindowWindowModeChange() {
- fireEvent(new Window.WindowModeChangeEvent(this, getState().windowMode));
- }
-
- /**
- * Method for the resize event.
- */
- private static final Method WINDOW_RESIZE_METHOD;
- static {
- try {
- WINDOW_RESIZE_METHOD = ResizeListener.class.getDeclaredMethod(
- "windowResized", new Class[] { ResizeEvent.class });
- } catch (final java.lang.NoSuchMethodException e) {
- // This should never happen
- throw new java.lang.RuntimeException(
- "Internal error, window resized method not found");
- }
- }
-
- /**
- * Resize events are fired whenever the client-side fires a resize-event
- * (e.g. the browser window is resized). The frequency may vary across
- * browsers.
- */
- public static class ResizeEvent extends Component.Event {
-
- /**
- *
- * @param source
- */
- public ResizeEvent(Component source) {
- super(source);
- }
-
- /**
- * Get the window form which this event originated
- *
- * @return the window
- */
- public Window getWindow() {
- return (Window) getSource();
- }
- }
-
- /**
- * Listener for window resize events.
- *
- * @see com.vaadin.ui.Window.ResizeEvent
- */
- public interface ResizeListener extends Serializable {
- public void windowResized(ResizeEvent e);
- }
-
- /**
- * Add a resize listener.
- *
- * @param listener
- */
- public void addResizeListener(ResizeListener listener) {
- addListener(ResizeEvent.class, listener, WINDOW_RESIZE_METHOD);
- }
-
- /**
- * @deprecated As of 7.0, replaced by
- * {@link #addResizeListener(ResizeListener)}
- **/
- @Deprecated
- public void addListener(ResizeListener listener) {
- addResizeListener(listener);
- }
-
- /**
- * Remove a resize listener.
- *
- * @param listener
- */
- public void removeResizeListener(ResizeListener listener) {
- removeListener(ResizeEvent.class, listener);
- }
-
- /**
- * @deprecated As of 7.0, replaced by
- * {@link #removeResizeListener(ResizeListener)}
- **/
- @Deprecated
- public void removeListener(ResizeListener listener) {
- removeResizeListener(listener);
- }
-
- /**
- * Fire the resize event.
- */
- protected void fireResize() {
- fireEvent(new ResizeEvent(this));
- }
-
- /**
- * Used to keep the right order of windows if multiple windows are brought
- * to front in a single changeset. If this is not used, the order is quite
- * random (depends on the order getting to dirty list. e.g. which window got
- * variable changes).
- */
- private Integer bringToFront = null;
-
- /**
- * If there are currently several windows visible, calling this method makes
- * this window topmost.
- * <p>
- * This method can only be called if this window connected a UI. Else an
- * illegal state exception is thrown. Also if there are modal windows and
- * this window is not modal, and illegal state exception is thrown.
- * <p>
- */
- public void bringToFront() {
- UI uI = getUI();
- if (uI == null) {
- throw new IllegalStateException(
- "Window must be attached to parent before calling bringToFront method.");
- }
- int maxBringToFront = -1;
- for (Window w : uI.getWindows()) {
- if (!isModal() && w.isModal()) {
- throw new IllegalStateException(
- "The UI contains modal windows, non-modal window cannot be brought to front.");
- }
- if (w.bringToFront != null) {
- maxBringToFront = Math.max(maxBringToFront,
- w.bringToFront.intValue());
- }
- }
- bringToFront = Integer.valueOf(maxBringToFront + 1);
- markAsDirty();
- }
-
- /**
- * Sets window modality. When a modal window is open, components outside
- * that window cannot be accessed.
- * <p>
- * Keyboard navigation is restricted by blocking the tab key at the top and
- * bottom of the window by activating the tab stop function internally.
- *
- * @param modal
- * true if modality is to be turned on
- */
- public void setModal(boolean modal) {
- getState().modal = modal;
- center();
- }
-
- /**
- * @return true if this window is modal.
- */
- public boolean isModal() {
- return getState(false).modal;
- }
-
- /**
- * Sets window resizable.
- *
- * @param resizable
- * true if resizability is to be turned on
- */
- public void setResizable(boolean resizable) {
- getState().resizable = resizable;
- }
-
- /**
- *
- * @return true if window is resizable by the end-user, otherwise false.
- */
- public boolean isResizable() {
- return getState(false).resizable;
- }
-
- /**
- *
- * @return true if a delay is used before recalculating sizes, false if
- * sizes are recalculated immediately.
- */
- public boolean isResizeLazy() {
- return getState(false).resizeLazy;
- }
-
- /**
- * Should resize operations be lazy, i.e. should there be a delay before
- * layout sizes are recalculated. Speeds up resize operations in slow UIs
- * with the penalty of slightly decreased usability.
- *
- * Note, some browser send false resize events for the browser window and
- * are therefore always lazy.
- *
- * @param resizeLazy
- * true to use a delay before recalculating sizes, false to
- * calculate immediately.
- */
- public void setResizeLazy(boolean resizeLazy) {
- getState().resizeLazy = resizeLazy;
- }
-
- /**
- * Sets this window to be centered relative to its parent window. Affects
- * windows only. If the window is resized as a result of the size of its
- * content changing, it will keep itself centered as long as its position is
- * not explicitly changed programmatically or by the user.
- * <p>
- * <b>NOTE:</b> This method has several issues as currently implemented.
- * Please refer to http://dev.vaadin.com/ticket/8971 for details.
- */
- public void center() {
- getState().centered = true;
- }
-
- /**
- * Returns the closable status of the window. If a window is closable, it
- * typically shows an X in the upper right corner. Clicking on the X sends a
- * close event to the server. Setting closable to false will remove the X
- * from the window and prevent the user from closing the window.
- *
- * Note! For historical reasons readonly controls the closability of the
- * window and therefore readonly and closable affect each other. Setting
- * readonly to true will set closable to false and vice versa.
- * <p/>
- *
- * @return true if the window can be closed by the user.
- */
- public boolean isClosable() {
- return !isReadOnly();
- }
-
- /**
- * Sets the closable status for the window. If a window is closable it
- * typically shows an X in the upper right corner. Clicking on the X sends a
- * close event to the server. Setting closable to false will remove the X
- * from the window and prevent the user from closing the window.
- *
- * Note! For historical reasons readonly controls the closability of the
- * window and therefore readonly and closable affect each other. Setting
- * readonly to true will set closable to false and vice versa.
- * <p/>
- *
- * @param closable
- * determines if the window can be closed by the user.
- */
- public void setClosable(boolean closable) {
- setReadOnly(!closable);
- }
-
- /**
- * Indicates whether a window can be dragged or not. By default a window is
- * draggable.
- * <p/>
- *
- * @param draggable
- * true if the window can be dragged by the user
- */
- public boolean isDraggable() {
- return getState(false).draggable;
- }
-
- /**
- * Enables or disables that a window can be dragged (moved) by the user. By
- * default a window is draggable.
- * <p/>
- *
- * @param draggable
- * true if the window can be dragged by the user
- */
- public void setDraggable(boolean draggable) {
- getState().draggable = draggable;
- }
-
- /**
- * Gets the current mode of the window.
- *
- * @see WindowMode
- * @return the mode of the window.
- */
- public WindowMode getWindowMode() {
- return getState(false).windowMode;
- }
-
- /**
- * Sets the mode for the window
- *
- * @see WindowMode
- * @param windowMode
- * The new mode
- */
- public void setWindowMode(WindowMode windowMode) {
- if (windowMode != getWindowMode()) {
- getState().windowMode = windowMode;
- fireWindowWindowModeChange();
- }
- }
-
- /*
- * Actions
- */
- protected CloseShortcut closeShortcut;
-
- /**
- * Makes is possible to close the window by pressing the given
- * {@link KeyCode} and (optional) {@link ModifierKey}s.<br/>
- * Note that this shortcut only reacts while the window has focus, closing
- * itself - if you want to close a window from a UI, use
- * {@link UI#addAction(com.vaadin.event.Action)} of the UI instead.
- *
- * @param keyCode
- * the keycode for invoking the shortcut
- * @param modifiers
- * the (optional) modifiers for invoking the shortcut, null for
- * none
- */
- public void setCloseShortcut(int keyCode, int... modifiers) {
- if (closeShortcut != null) {
- removeAction(closeShortcut);
- }
- closeShortcut = new CloseShortcut(this, keyCode, modifiers);
- addAction(closeShortcut);
- }
-
- /**
- * Removes the keyboard shortcut previously set with
- * {@link #setCloseShortcut(int, int...)}.
- */
- public void removeCloseShortcut() {
- if (closeShortcut != null) {
- removeAction(closeShortcut);
- closeShortcut = null;
- }
- }
-
- /**
- * A {@link ShortcutListener} specifically made to define a keyboard
- * shortcut that closes the window.
- *
- * <pre>
- * <code>
- * // within the window using helper
- * window.setCloseShortcut(KeyCode.ESCAPE, null);
- *
- * // or globally
- * getUI().addAction(new Window.CloseShortcut(window, KeyCode.ESCAPE));
- * </code>
- * </pre>
- *
- */
- public static class CloseShortcut extends ShortcutListener {
- protected Window window;
-
- /**
- * Creates a keyboard shortcut for closing the given window using the
- * shorthand notation defined in {@link ShortcutAction}.
- *
- * @param window
- * to be closed when the shortcut is invoked
- * @param shorthandCaption
- * the caption with shortcut keycode and modifiers indicated
- */
- public CloseShortcut(Window window, String shorthandCaption) {
- super(shorthandCaption);
- this.window = window;
- }
-
- /**
- * Creates a keyboard shortcut for closing the given window using the
- * given {@link KeyCode} and {@link ModifierKey}s.
- *
- * @param window
- * to be closed when the shortcut is invoked
- * @param keyCode
- * KeyCode to react to
- * @param modifiers
- * optional modifiers for shortcut
- */
- public CloseShortcut(Window window, int keyCode, int... modifiers) {
- super(null, keyCode, modifiers);
- this.window = window;
- }
-
- /**
- * Creates a keyboard shortcut for closing the given window using the
- * given {@link KeyCode}.
- *
- * @param window
- * to be closed when the shortcut is invoked
- * @param keyCode
- * KeyCode to react to
- */
- public CloseShortcut(Window window, int keyCode) {
- this(window, keyCode, null);
- }
-
- @Override
- public void handleAction(Object sender, Object target) {
- window.close();
- }
- }
-
- /*
- * (non-Javadoc)
- *
- * @see
- * com.vaadin.event.FieldEvents.FocusNotifier#addFocusListener(com.vaadin
- * .event.FieldEvents.FocusListener)
- */
- @Override
- public void addFocusListener(FocusListener listener) {
- addListener(FocusEvent.EVENT_ID, FocusEvent.class, listener,
- FocusListener.focusMethod);
- }
-
- /**
- * @deprecated As of 7.0, replaced by
- * {@link #addFocusListener(FocusListener)}
- **/
- @Override
- @Deprecated
- public void addListener(FocusListener listener) {
- addFocusListener(listener);
- }
-
- @Override
- public void removeFocusListener(FocusListener listener) {
- removeListener(FocusEvent.EVENT_ID, FocusEvent.class, listener);
- }
-
- /**
- * @deprecated As of 7.0, replaced by
- * {@link #removeFocusListener(FocusListener)}
- **/
- @Override
- @Deprecated
- public void removeListener(FocusListener listener) {
- removeFocusListener(listener);
- }
-
- /*
- * (non-Javadoc)
- *
- * @see
- * com.vaadin.event.FieldEvents.BlurNotifier#addBlurListener(com.vaadin.
- * event.FieldEvents.BlurListener)
- */
- @Override
- public void addBlurListener(BlurListener listener) {
- addListener(BlurEvent.EVENT_ID, BlurEvent.class, listener,
- BlurListener.blurMethod);
- }
-
- /**
- * @deprecated As of 7.0, replaced by {@link #addBlurListener(BlurListener)}
- **/
- @Override
- @Deprecated
- public void addListener(BlurListener listener) {
- addBlurListener(listener);
- }
-
- @Override
- public void removeBlurListener(BlurListener listener) {
- removeListener(BlurEvent.EVENT_ID, BlurEvent.class, listener);
- }
-
- /**
- * @deprecated As of 7.0, replaced by
- * {@link #removeBlurListener(BlurListener)}
- **/
- @Override
- @Deprecated
- public void removeListener(BlurListener listener) {
- removeBlurListener(listener);
- }
-
- /**
- * {@inheritDoc}
- *
- * Cause the window to be brought on top of other windows and gain keyboard
- * focus.
- */
- @Override
- public void focus() {
- /*
- * When focusing a window it basically means it should be brought to the
- * front. Instead of just moving the keyboard focus we focus the window
- * and bring it top-most.
- */
- super.focus();
- bringToFront();
- }
-
- @Override
- protected WindowState getState() {
- return (WindowState) super.getState();
- }
-
- @Override
- protected WindowState getState(boolean markAsDirty) {
- return (WindowState) super.getState(markAsDirty);
- }
-
- /**
- * Allows to specify which components contain the description for the
- * window. Text contained in these components will be read by assistive
- * devices when it is opened.
- *
- * @param components
- * the components to use as description
- */
- public void setAssistiveDescription(Component... components) {
- if (components == null) {
- throw new IllegalArgumentException(
- "Parameter connectors must be non-null");
- } else {
- getState().contentDescription = components;
- }
- }
-
- /**
- * Gets the components that are used as assistive description. Text
- * contained in these components will be read by assistive devices when the
- * window is opened.
- *
- * @return array of previously set components
- */
- public Component[] getAssistiveDescription() {
- Connector[] contentDescription = getState().contentDescription;
- if (contentDescription == null) {
- return null;
- }
-
- Component[] target = new Component[contentDescription.length];
- System.arraycopy(contentDescription, 0, target, 0,
- contentDescription.length);
-
- return target;
- }
-
- /**
- * Sets the accessibility prefix for the window caption.
- *
- * This prefix is read to assistive device users before the window caption,
- * but not visible on the page.
- *
- * @param prefix
- * String that is placed before the window caption
- */
- public void setAssistivePrefix(String prefix) {
- getState().assistivePrefix = prefix;
- }
-
- /**
- * Gets the accessibility prefix for the window caption.
- *
- * This prefix is read to assistive device users before the window caption,
- * but not visible on the page.
- *
- * @return The accessibility prefix
- */
- public String getAssistivePrefix() {
- return getState(false).assistivePrefix;
- }
-
- /**
- * Sets the accessibility postfix for the window caption.
- *
- * This postfix is read to assistive device users after the window caption,
- * but not visible on the page.
- *
- * @param prefix
- * String that is placed after the window caption
- */
- public void setAssistivePostfix(String assistivePostfix) {
- getState().assistivePostfix = assistivePostfix;
- }
-
- /**
- * Gets the accessibility postfix for the window caption.
- *
- * This postfix is read to assistive device users after the window caption,
- * but not visible on the page.
- *
- * @return The accessibility postfix
- */
- public String getAssistivePostfix() {
- return getState(false).assistivePostfix;
- }
-
- /**
- * Sets the WAI-ARIA role the window.
- *
- * This role defines how an assistive device handles a window. Available
- * roles are alertdialog and dialog (@see <a
- * href="http://www.w3.org/TR/2011/CR-wai-aria-20110118/roles">Roles
- * Model</a>).
- *
- * The default role is dialog.
- *
- * @param role
- * WAI-ARIA role to set for the window
- */
- public void setAssistiveRole(WindowRole role) {
- getState().role = role;
- }
-
- /**
- * Gets the WAI-ARIA role the window.
- *
- * This role defines how an assistive device handles a window. Available
- * roles are alertdialog and dialog (@see <a
- * href="http://www.w3.org/TR/2011/CR-wai-aria-20110118/roles">Roles
- * Model</a>).
- *
- * @return WAI-ARIA role set for the window
- */
- public WindowRole getAssistiveRole() {
- return getState(false).role;
- }
-
- /**
- * Set if it should be prevented to set the focus to a component outside a
- * non-modal window with the tab key.
- * <p>
- * This is meant to help users of assistive devices to not leaving the
- * window unintentionally.
- * <p>
- * For modal windows, this function is activated automatically, while
- * preserving the stored value of tabStop.
- *
- * @param tabStop
- * true to keep the focus inside the window when reaching the top
- * or bottom, false (default) to allow leaving the window
- */
- public void setTabStopEnabled(boolean tabStop) {
- getState().assistiveTabStop = tabStop;
- }
-
- /**
- * Get if it is prevented to leave a window with the tab key.
- *
- * @return true when the focus is limited to inside the window, false when
- * focus can leave the window
- */
- public boolean isTabStopEnabled() {
- return getState(false).assistiveTabStop;
- }
-
- /**
- * Sets the message that is provided to users of assistive devices when the
- * user reaches the top of the window when leaving a window with the tab key
- * is prevented.
- * <p>
- * This message is not visible on the screen.
- *
- * @param topMessage
- * String provided when the user navigates with Shift-Tab keys to
- * the top of the window
- */
- public void setTabStopTopAssistiveText(String topMessage) {
- getState().assistiveTabStopTopText = topMessage;
- }
-
- /**
- * Sets the message that is provided to users of assistive devices when the
- * user reaches the bottom of the window when leaving a window with the tab
- * key is prevented.
- * <p>
- * This message is not visible on the screen.
- *
- * @param bottomMessage
- * String provided when the user navigates with the Tab key to
- * the bottom of the window
- */
- public void setTabStopBottomAssistiveText(String bottomMessage) {
- getState().assistiveTabStopBottomText = bottomMessage;
- }
-
- /**
- * Gets the message that is provided to users of assistive devices when the
- * user reaches the top of the window when leaving a window with the tab key
- * is prevented.
- *
- * @return the top message
- */
- public String getTabStopTopAssistiveText() {
- return getState(false).assistiveTabStopTopText;
- }
-
- /**
- * Gets the message that is provided to users of assistive devices when the
- * user reaches the bottom of the window when leaving a window with the tab
- * key is prevented.
- *
- * @return the bottom message
- */
- public String getTabStopBottomAssistiveText() {
- return getState(false).assistiveTabStopBottomText;
- }
- }
|