diff options
author | Teemu Suo-Anttila <teemusa@vaadin.com> | 2016-03-10 22:40:51 +0200 |
---|---|---|
committer | Teemu Suo-Anttila <teemusa@vaadin.com> | 2016-03-14 07:59:12 +0200 |
commit | a6653d3fe49e6a97468ac09f7f2f4d621bea1078 (patch) | |
tree | 96c82e20ca6551ee4c14c8877f0258b25c63cddf /server/src/main/java/com/vaadin/ui/Panel.java | |
parent | f7e57d77ce621ee39167369c31d989edc5633266 (diff) | |
download | vaadin-framework-a6653d3fe49e6a97468ac09f7f2f4d621bea1078.tar.gz vaadin-framework-a6653d3fe49e6a97468ac09f7f2f4d621bea1078.zip |
Migrate vaadin-server build to maven
Change-Id: I5c740f4e9cb28103bab199f9a552153d82277e7e
Diffstat (limited to 'server/src/main/java/com/vaadin/ui/Panel.java')
-rw-r--r-- | server/src/main/java/com/vaadin/ui/Panel.java | 364 |
1 files changed, 364 insertions, 0 deletions
diff --git a/server/src/main/java/com/vaadin/ui/Panel.java b/server/src/main/java/com/vaadin/ui/Panel.java new file mode 100644 index 0000000000..6458d5f57d --- /dev/null +++ b/server/src/main/java/com/vaadin/ui/Panel.java @@ -0,0 +1,364 @@ +/* + * 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.util.Collection; +import java.util.Map; + +import org.jsoup.nodes.Element; + +import com.vaadin.event.Action; +import com.vaadin.event.Action.Handler; +import com.vaadin.event.ActionManager; +import com.vaadin.event.MouseEvents.ClickEvent; +import com.vaadin.event.MouseEvents.ClickListener; +import com.vaadin.server.PaintException; +import com.vaadin.server.PaintTarget; +import com.vaadin.server.Scrollable; +import com.vaadin.shared.EventId; +import com.vaadin.shared.MouseEventDetails; +import com.vaadin.shared.ui.panel.PanelServerRpc; +import com.vaadin.shared.ui.panel.PanelState; +import com.vaadin.ui.Component.Focusable; +import com.vaadin.ui.declarative.DesignContext; + +/** + * Panel - a simple single component container. + * + * @author Vaadin Ltd. + * @since 3.0 + */ +@SuppressWarnings("serial") +public class Panel extends AbstractSingleComponentContainer implements + Scrollable, Action.Notifier, Focusable, LegacyComponent { + + /** + * Keeps track of the Actions added to this component, and manages the + * painting and handling as well. + */ + protected ActionManager actionManager; + + private PanelServerRpc rpc = new PanelServerRpc() { + @Override + public void click(MouseEventDetails mouseDetails) { + fireEvent(new ClickEvent(Panel.this, mouseDetails)); + } + }; + + /** + * Creates a new empty panel. + */ + public Panel() { + this((ComponentContainer) null); + } + + /** + * Creates a new empty panel which contains the given content. + * + * @param content + * the content for the panel. + */ + public Panel(Component content) { + registerRpc(rpc); + setContent(content); + setWidth(100, Unit.PERCENTAGE); + getState().tabIndex = -1; + } + + /** + * Creates a new empty panel with caption. + * + * @param caption + * the caption used in the panel (HTML). + */ + public Panel(String caption) { + this(caption, null); + } + + /** + * Creates a new empty panel with the given caption and content. + * + * @param caption + * the caption of the panel (HTML). + * @param content + * the content used in the panel. + */ + public Panel(String caption, Component content) { + this(content); + setCaption(caption); + } + + /** + * Sets the caption of the panel. + * + * Note that the caption is interpreted as HTML and therefore care should be + * taken not to enable HTML injection and XSS attacks using panel captions. + * This behavior may change in future versions. + * + * @see AbstractComponent#setCaption(String) + */ + @Override + public void setCaption(String caption) { + super.setCaption(caption); + } + + /* + * (non-Javadoc) + * + * @see com.vaadin.server.LegacyComponent#paintContent(com.vaadin.server + * .PaintTarget) + */ + @Override + public void paintContent(PaintTarget target) throws PaintException { + if (actionManager != null) { + actionManager.paintActions(null, target); + } + } + + /** + * Called when one or more variables handled by the implementing class are + * changed. + * + * @see com.vaadin.server.VariableOwner#changeVariables(Object, Map) + */ + @Override + public void changeVariables(Object source, Map<String, Object> variables) { + // Get new size + final Integer newWidth = (Integer) variables.get("width"); + final Integer newHeight = (Integer) variables.get("height"); + if (newWidth != null && newWidth.intValue() != getWidth()) { + setWidth(newWidth.intValue(), UNITS_PIXELS); + } + if (newHeight != null && newHeight.intValue() != getHeight()) { + setHeight(newHeight.intValue(), UNITS_PIXELS); + } + + // Scrolling + final Integer newScrollX = (Integer) variables.get("scrollLeft"); + final Integer newScrollY = (Integer) variables.get("scrollTop"); + if (newScrollX != null && newScrollX.intValue() != getScrollLeft()) { + // set internally, not to fire request repaint + getState().scrollLeft = newScrollX.intValue(); + } + if (newScrollY != null && newScrollY.intValue() != getScrollTop()) { + // set internally, not to fire request repaint + getState().scrollTop = newScrollY.intValue(); + } + + // Actions + if (actionManager != null) { + actionManager.handleActions(variables, this); + } + + } + + /* Scrolling functionality */ + + /* + * (non-Javadoc) + * + * @see com.vaadin.server.Scrollable#setScrollable(boolean) + */ + @Override + public int getScrollLeft() { + return getState(false).scrollLeft; + } + + /* + * (non-Javadoc) + * + * @see com.vaadin.server.Scrollable#setScrollable(boolean) + */ + @Override + public int getScrollTop() { + return getState(false).scrollTop; + } + + /* + * (non-Javadoc) + * + * @see com.vaadin.server.Scrollable#setScrollLeft(int) + */ + @Override + public void setScrollLeft(int scrollLeft) { + if (scrollLeft < 0) { + throw new IllegalArgumentException( + "Scroll offset must be at least 0"); + } + getState().scrollLeft = scrollLeft; + } + + /* + * (non-Javadoc) + * + * @see com.vaadin.server.Scrollable#setScrollTop(int) + */ + @Override + public void setScrollTop(int scrollTop) { + if (scrollTop < 0) { + throw new IllegalArgumentException( + "Scroll offset must be at least 0"); + } + getState().scrollTop = scrollTop; + } + + /* + * ACTIONS + */ + @Override + protected ActionManager getActionManager() { + if (actionManager == null) { + actionManager = new ActionManager(this); + } + return actionManager; + } + + @Override + public <T extends Action & com.vaadin.event.Action.Listener> void addAction( + T action) { + getActionManager().addAction(action); + } + + @Override + public <T extends Action & com.vaadin.event.Action.Listener> void removeAction( + T action) { + if (actionManager != null) { + actionManager.removeAction(action); + } + } + + @Override + public void addActionHandler(Handler actionHandler) { + getActionManager().addActionHandler(actionHandler); + } + + @Override + public void removeActionHandler(Handler actionHandler) { + if (actionManager != null) { + actionManager.removeActionHandler(actionHandler); + } + } + + /** + * Removes all action handlers + */ + public void removeAllActionHandlers() { + if (actionManager != null) { + actionManager.removeAllActionHandlers(); + } + } + + /** + * Add a click listener to the Panel. The listener is called whenever the + * user clicks inside the Panel. Also when the click targets a component + * inside the Panel, provided the targeted component does not prevent the + * click event from propagating. + * + * Use {@link #removeListener(ClickListener)} to remove the listener. + * + * @param listener + * The listener to add + */ + public void addClickListener(ClickListener listener) { + addListener(EventId.CLICK_EVENT_IDENTIFIER, ClickEvent.class, listener, + ClickListener.clickMethod); + } + + /** + * @deprecated As of 7.0, replaced by + * {@link #addClickListener(ClickListener)} + **/ + @Deprecated + public void addListener(ClickListener listener) { + addClickListener(listener); + } + + /** + * Remove a click listener from the Panel. The listener should earlier have + * been added using {@link #addListener(ClickListener)}. + * + * @param listener + * The listener to remove + */ + public void removeClickListener(ClickListener listener) { + removeListener(EventId.CLICK_EVENT_IDENTIFIER, ClickEvent.class, + listener); + } + + /** + * @deprecated As of 7.0, replaced by + * {@link #removeClickListener(ClickListener)} + **/ + @Deprecated + public void removeListener(ClickListener listener) { + removeClickListener(listener); + } + + /** + * {@inheritDoc} + */ + @Override + public int getTabIndex() { + return getState(false).tabIndex; + } + + /** + * {@inheritDoc} + */ + @Override + public void setTabIndex(int tabIndex) { + getState().tabIndex = tabIndex; + } + + /** + * Moves keyboard focus to the component. {@see Focusable#focus()} + * + */ + @Override + public void focus() { + super.focus(); + } + + @Override + protected PanelState getState() { + return (PanelState) super.getState(); + } + + @Override + protected PanelState getState(boolean markAsDirty) { + return (PanelState) super.getState(markAsDirty); + } + + @Override + public void readDesign(Element design, DesignContext designContext) { + super.readDesign(design, designContext); + } + + @Override + protected Collection<String> getCustomAttributes() { + Collection<String> attributes = super.getCustomAttributes(); + return attributes; + } + + @Override + public void writeDesign(Element design, DesignContext designContext) { + super.writeDesign(design, designContext); + // handle tabindex + Panel def = (Panel) designContext.getDefaultInstance(this); + } + +} |