diff options
Diffstat (limited to 'client')
4 files changed, 191 insertions, 37 deletions
diff --git a/client/src/com/vaadin/client/ui/ShortcutAction.java b/client/src/com/vaadin/client/ui/ShortcutAction.java new file mode 100644 index 0000000000..3209c02203 --- /dev/null +++ b/client/src/com/vaadin/client/ui/ShortcutAction.java @@ -0,0 +1,108 @@ +/* + * Copyright 2011 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.client.ui; + +import com.vaadin.client.ApplicationConnection; +import com.vaadin.server.KeyMapper; + +public class ShortcutAction { + + private final ShortcutKeyCombination sc; + private final String caption; + private final String key; + private String targetCID; + private String targetAction; + + /** + * Constructor + * + * @param key + * The @link {@link KeyMapper} key of the action. + * @param sc + * The key combination that triggers the action + * @param caption + * The caption of the action + */ + public ShortcutAction(String key, ShortcutKeyCombination sc, String caption) { + this(key, sc, caption, null, null); + } + + /** + * Constructor + * + * @param key + * The @link {@link KeyMapper} key of the action. + * @param sc + * The key combination that triggers the action + * @param caption + * The caption of the action + * @param targetPID + * The pid of the component the action is targeting. We use the + * pid, instead of the actual Paintable here, so we can delay the + * fetching of the Paintable in cases where the Paintable does + * not yet exist when the action is painted. + * @param targetAction + * The target string of the action. The target string is given to + * the targeted Paintable if the paintable implements the + * {@link ShortcutActionTarget} interface. + */ + public ShortcutAction(String key, ShortcutKeyCombination sc, + String caption, String targetCID, String targetAction) { + this.sc = sc; + this.key = key; + this.caption = caption; + this.targetCID = targetCID; + this.targetAction = targetAction; + } + + /** + * Get the key combination that triggers the action + */ + public ShortcutKeyCombination getShortcutCombination() { + return sc; + } + + /** + * Get the caption of the action + */ + public String getCaption() { + return caption; + } + + /** + * Get the {@link KeyMapper} key for the action + */ + public String getKey() { + return key; + } + + /** + * Get the pid of the target of the action. Use + * {@link ApplicationConnection#getPaintable(String)} to get the actual + * Paintable + */ + public String getTargetCID() { + return targetCID; + } + + /** + * Get the target string of the action + */ + public String getTargetAction() { + return targetAction; + } + +}
\ No newline at end of file diff --git a/client/src/com/vaadin/client/ui/ShortcutActionHandler.java b/client/src/com/vaadin/client/ui/ShortcutActionHandler.java index 8dc0d9def7..929de7a15d 100644 --- a/client/src/com/vaadin/client/ui/ShortcutActionHandler.java +++ b/client/src/com/vaadin/client/ui/ShortcutActionHandler.java @@ -30,9 +30,11 @@ import com.google.gwt.user.client.ui.KeyboardListenerCollection; import com.vaadin.client.ApplicationConnection; import com.vaadin.client.BrowserInfo; import com.vaadin.client.ComponentConnector; +import com.vaadin.client.ConnectorMap; import com.vaadin.client.UIDL; import com.vaadin.client.Util; import com.vaadin.client.ui.richtextarea.VRichTextArea; +import com.vaadin.shared.Connector; /** * A helper class to implement keyboard shorcut handling. Keeps a list of owners @@ -43,6 +45,15 @@ import com.vaadin.client.ui.richtextarea.VRichTextArea; */ public class ShortcutActionHandler { + public static final String ACTION_TARGET_ATTRIBUTE = "sat"; + public static final String ACTION_TARGET_ACTION_ATTRIBUTE = "sata"; + public static final String ACTION_CAPTION_ATTRIBUTE = "caption"; + public static final String ACTION_KEY_ATTRIBUTE = "key"; + public static final String ACTION_SHORTCUT_KEY_ATTRIBUTE = "kc"; + public static final String ACTION_MODIFIER_KEYS_ATTRIBUTE = "mk"; + public static final String ACTION_TARGET_VARIABLE = "actiontarget"; + public static final String ACTION_TARGET_ACTION_VARIABLE = "action"; + /** * An interface implemented by those users of this helper class that want to * support special components like {@link VRichTextArea} that don't properly @@ -108,15 +119,23 @@ public class ShortcutActionHandler { final UIDL action = (UIDL) it.next(); int[] modifiers = null; - if (action.hasAttribute("mk")) { - modifiers = action.getIntArrayAttribute("mk"); + if (action.hasAttribute(ACTION_MODIFIER_KEYS_ATTRIBUTE)) { + modifiers = action + .getIntArrayAttribute(ACTION_MODIFIER_KEYS_ATTRIBUTE); } final ShortcutKeyCombination kc = new ShortcutKeyCombination( - action.getIntAttribute("kc"), modifiers); - final String key = action.getStringAttribute("key"); - final String caption = action.getStringAttribute("caption"); - actions.add(new ShortcutAction(key, kc, caption)); + action.getIntAttribute(ACTION_SHORTCUT_KEY_ATTRIBUTE), + modifiers); + final String key = action.getStringAttribute(ACTION_KEY_ATTRIBUTE); + final String caption = action + .getStringAttribute(ACTION_CAPTION_ATTRIBUTE); + final String targetPID = action + .getStringAttribute(ACTION_TARGET_ATTRIBUTE); + final String targetAction = action + .getStringAttribute(ACTION_TARGET_ACTION_ATTRIBUTE); + actions.add(new ShortcutAction(key, kc, caption, targetPID, + targetAction)); } } @@ -171,11 +190,22 @@ public class ShortcutActionHandler { Scheduler.get().scheduleDeferred(new Command() { @Override public void execute() { - if (finalTarget != null) { - client.updateVariable(paintableId, "actiontarget", - finalTarget, false); + Connector shortcutTarget = ConnectorMap.get(client) + .getConnector(a.getTargetCID()); + + boolean handledClientSide = false; + if (shortcutTarget instanceof ShortcutActionTarget) { + handledClientSide = ((ShortcutActionTarget) shortcutTarget) + .handleAction(a); + } + if (!handledClientSide) { + if (finalTarget != null) { + client.updateVariable(paintableId, + ACTION_TARGET_VARIABLE, finalTarget, false); + } + client.updateVariable(paintableId, + ACTION_TARGET_ACTION_VARIABLE, a.getKey(), true); } - client.updateVariable(paintableId, "action", a.getKey(), true); } }); } @@ -282,29 +312,3 @@ class ShortcutKeyCombination { return false; } } - -class ShortcutAction { - - private final ShortcutKeyCombination sc; - private final String caption; - private final String key; - - public ShortcutAction(String key, ShortcutKeyCombination sc, String caption) { - this.sc = sc; - this.key = key; - this.caption = caption; - } - - public ShortcutKeyCombination getShortcutCombination() { - return sc; - } - - public String getCaption() { - return caption; - } - - public String getKey() { - return key; - } - -} diff --git a/client/src/com/vaadin/client/ui/ShortcutActionTarget.java b/client/src/com/vaadin/client/ui/ShortcutActionTarget.java new file mode 100644 index 0000000000..617334600e --- /dev/null +++ b/client/src/com/vaadin/client/ui/ShortcutActionTarget.java @@ -0,0 +1,24 @@ +/* +@VaadinApache2LicenseForJavaFiles@ + */ +package com.vaadin.client.ui; + +/** + * Widgets who wish to be notificed when a shortcut action has been triggered + * with the widget as a target should implement this interface. The + * {@link #handleAction(ShortcutAction)} method will be called just before the + * action is communicated to the server + * + */ +public interface ShortcutActionTarget { + + /** + * Called by the {@link ShortcutActionHandler} just before the shortcut + * action is sent to the server side + * + * @param action + * The action which will be performed on the server side + * @return Returns true if the shortcut was handled + */ + boolean handleAction(ShortcutAction action); +} diff --git a/client/src/com/vaadin/client/ui/button/ButtonConnector.java b/client/src/com/vaadin/client/ui/button/ButtonConnector.java index b15813c99e..546bdecb61 100644 --- a/client/src/com/vaadin/client/ui/button/ButtonConnector.java +++ b/client/src/com/vaadin/client/ui/button/ButtonConnector.java @@ -33,6 +33,8 @@ import com.vaadin.client.communication.StateChangeEvent; import com.vaadin.client.communication.StateChangeEvent.StateChangeHandler; import com.vaadin.client.ui.AbstractComponentConnector; import com.vaadin.client.ui.Icon; +import com.vaadin.client.ui.ShortcutAction; +import com.vaadin.client.ui.ShortcutActionTarget; import com.vaadin.shared.MouseEventDetails; import com.vaadin.shared.communication.FieldRpc.FocusAndBlurServerRpc; import com.vaadin.shared.ui.Connect; @@ -43,7 +45,7 @@ import com.vaadin.ui.Button; @Connect(value = Button.class, loadStyle = LoadStyle.EAGER) public class ButtonConnector extends AbstractComponentConnector implements - BlurHandler, FocusHandler, ClickHandler { + BlurHandler, FocusHandler, ClickHandler, ShortcutActionTarget { private ButtonServerRpc rpc = RpcProxy.create(ButtonServerRpc.class, this); private FocusAndBlurServerRpc focusBlurProxy = RpcProxy.create( @@ -165,4 +167,20 @@ public class ButtonConnector extends AbstractComponentConnector implements rpc.click(details); } + + /* + * (non-Javadoc) + * + * @see + * com.vaadin.terminal.gwt.client.ui.ShortcutActionTarget#handleAction(com + * .vaadin.terminal.gwt.client.ui.ShortcutAction) + */ + public boolean handleAction(ShortcutAction action) { + if ("click".equals(action.getTargetAction())) { + getWidget().onClick(); + return true; + } + return false; + } + } |