12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079 |
- /*
- * 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.ArrayList;
- import java.util.Iterator;
- import java.util.List;
- import java.util.Locale;
- import java.util.StringTokenizer;
- import java.util.regex.Matcher;
- import java.util.regex.Pattern;
-
- import org.jsoup.nodes.Attributes;
- import org.jsoup.nodes.Node;
-
- import com.vaadin.event.ActionManager;
- import com.vaadin.event.ConnectorActionManager;
- import com.vaadin.event.ShortcutListener;
- import com.vaadin.server.AbstractClientConnector;
- import com.vaadin.server.ComponentSizeValidator;
- import com.vaadin.server.ErrorMessage;
- import com.vaadin.server.Resource;
- import com.vaadin.server.VaadinSession;
- import com.vaadin.shared.AbstractComponentState;
- import com.vaadin.shared.ComponentConstants;
- import com.vaadin.shared.ui.ComponentStateUtil;
- import com.vaadin.shared.util.SharedUtil;
- import com.vaadin.ui.Field.ValueChangeEvent;
- import com.vaadin.ui.declarative.DesignAttributeHandler;
- import com.vaadin.ui.declarative.DesignContext;
- import com.vaadin.util.ReflectTools;
-
- /**
- * An abstract class that defines default implementation for the
- * {@link Component} interface. Basic UI components that are not derived from an
- * external component can inherit this class to easily qualify as Vaadin
- * components. Most components in Vaadin do just that.
- *
- * @author Vaadin Ltd.
- * @since 3.0
- */
- @SuppressWarnings("serial")
- public abstract class AbstractComponent extends AbstractClientConnector
- implements Component, DesignSynchronizable {
-
- /* Private members */
-
- /**
- * Application specific data object. The component does not use or modify
- * this.
- */
- private Object applicationData;
-
- /**
- * The internal error message of the component.
- */
- private ErrorMessage componentError = null;
-
- /**
- * Locale of this component.
- */
- private Locale locale;
-
- /**
- * The component should receive focus (if {@link Focusable}) when attached.
- */
- private boolean delayedFocus;
-
- /* Sizeable fields */
-
- private float width = SIZE_UNDEFINED;
- private float height = SIZE_UNDEFINED;
- private Unit widthUnit = Unit.PIXELS;
- private Unit heightUnit = Unit.PIXELS;
- private static final Pattern sizePattern = Pattern
- .compile(SharedUtil.SIZE_PATTERN);
-
- /**
- * Keeps track of the Actions added to this component; the actual
- * handling/notifying is delegated, usually to the containing window.
- */
- private ConnectorActionManager actionManager;
-
- private boolean visible = true;
-
- private HasComponents parent;
-
- private Boolean explicitImmediateValue;
-
- /* Constructor */
-
- /**
- * Constructs a new Component.
- */
- public AbstractComponent() {
- // ComponentSizeValidator.setCreationLocation(this);
- }
-
- /* Get/Set component properties */
-
- /*
- * (non-Javadoc)
- *
- * @see com.vaadin.ui.Component#setId(java.lang.String)
- */
- @Override
- public void setId(String id) {
- getState().id = id;
- }
-
- /*
- * (non-Javadoc)
- *
- * @see com.vaadin.ui.Component#getId()
- */
- @Override
- public String getId() {
- return getState(false).id;
- }
-
- /**
- * @deprecated As of 7.0. Use {@link #setId(String)}
- */
- @Deprecated
- public void setDebugId(String id) {
- setId(id);
- }
-
- /**
- * @deprecated As of 7.0. Use {@link #getId()}
- */
- @Deprecated
- public String getDebugId() {
- return getId();
- }
-
- /*
- * Gets the component's style. Don't add a JavaDoc comment here, we use the
- * default documentation from implemented interface.
- */
- @Override
- public String getStyleName() {
- String s = "";
- if (ComponentStateUtil.hasStyles(getState(false))) {
- for (final Iterator<String> it = getState(false).styles.iterator(); it
- .hasNext();) {
- s += it.next();
- if (it.hasNext()) {
- s += " ";
- }
- }
- }
- return s;
- }
-
- /*
- * Sets the component's style. Don't add a JavaDoc comment here, we use the
- * default documentation from implemented interface.
- */
- @Override
- public void setStyleName(String style) {
- if (style == null || "".equals(style)) {
- getState().styles = null;
- return;
- }
- if (getState().styles == null) {
- getState().styles = new ArrayList<String>();
- }
- List<String> styles = getState().styles;
- styles.clear();
- StringTokenizer tokenizer = new StringTokenizer(style, " ");
- while (tokenizer.hasMoreTokens()) {
- styles.add(tokenizer.nextToken());
- }
- }
-
- @Override
- public void setPrimaryStyleName(String style) {
- getState().primaryStyleName = style;
- }
-
- @Override
- public String getPrimaryStyleName() {
- return getState(false).primaryStyleName;
- }
-
- @Override
- public void addStyleName(String style) {
- if (style == null || "".equals(style)) {
- return;
- }
- if (style.contains(" ")) {
- // Split space separated style names and add them one by one.
- StringTokenizer tokenizer = new StringTokenizer(style, " ");
- while (tokenizer.hasMoreTokens()) {
- addStyleName(tokenizer.nextToken());
- }
- return;
- }
-
- if (getState().styles == null) {
- getState().styles = new ArrayList<String>();
- }
- List<String> styles = getState().styles;
- if (!styles.contains(style)) {
- styles.add(style);
- }
- }
-
- @Override
- public void removeStyleName(String style) {
- if (ComponentStateUtil.hasStyles(getState())) {
- StringTokenizer tokenizer = new StringTokenizer(style, " ");
- while (tokenizer.hasMoreTokens()) {
- getState().styles.remove(tokenizer.nextToken());
- }
- }
- }
-
- /*
- * Get's the component's caption. Don't add a JavaDoc comment here, we use
- * the default documentation from implemented interface.
- */
- @Override
- public String getCaption() {
- return getState(false).caption;
- }
-
- /**
- * Sets the component's caption <code>String</code>. Caption is the visible
- * name of the component. This method will trigger a
- * {@link RepaintRequestEvent}.
- *
- * @param caption
- * the new caption <code>String</code> for the component.
- */
- @Override
- public void setCaption(String caption) {
- getState().caption = caption;
- }
-
- /*
- * Don't add a JavaDoc comment here, we use the default documentation from
- * implemented interface.
- */
- @Override
- public Locale getLocale() {
- if (locale != null) {
- return locale;
- }
- HasComponents parent = getParent();
- if (parent != null) {
- return parent.getLocale();
- }
- final VaadinSession session = getSession();
- if (session != null) {
- return session.getLocale();
- }
- return null;
- }
-
- /**
- * Sets the locale of this component.
- *
- * <pre>
- * // Component for which the locale is meaningful
- * InlineDateField date = new InlineDateField("Datum");
- *
- * // German language specified with ISO 639-1 language
- * // code and ISO 3166-1 alpha-2 country code.
- * date.setLocale(new Locale("de", "DE"));
- *
- * date.setResolution(DateField.RESOLUTION_DAY);
- * layout.addComponent(date);
- * </pre>
- *
- *
- * @param locale
- * the locale to become this component's locale.
- */
- public void setLocale(Locale locale) {
- this.locale = locale;
-
- if (locale != null && isAttached()) {
- getUI().getLocaleService().addLocale(locale);
- }
-
- markAsDirty();
- }
-
- /*
- * Gets the component's icon resource. Don't add a JavaDoc comment here, we
- * use the default documentation from implemented interface.
- */
- @Override
- public Resource getIcon() {
- return getResource(ComponentConstants.ICON_RESOURCE);
- }
-
- /**
- * Sets the component's icon. This method will trigger a
- * {@link RepaintRequestEvent}.
- *
- * @param icon
- * the icon to be shown with the component's caption.
- */
- @Override
- public void setIcon(Resource icon) {
- setResource(ComponentConstants.ICON_RESOURCE, icon);
- }
-
- /*
- * (non-Javadoc)
- *
- * @see com.vaadin.ui.Component#isEnabled()
- */
- @Override
- public boolean isEnabled() {
- return getState(false).enabled;
- }
-
- /*
- * (non-Javadoc)
- *
- * @see com.vaadin.ui.Component#setEnabled(boolean)
- */
- @Override
- public void setEnabled(boolean enabled) {
- getState().enabled = enabled;
- }
-
- /*
- * (non-Javadoc)
- *
- * @see com.vaadin.client.Connector#isConnectorEnabled()
- */
- @Override
- public boolean isConnectorEnabled() {
- if (!isVisible()) {
- return false;
- } else if (!isEnabled()) {
- return false;
- } else if (!super.isConnectorEnabled()) {
- return false;
- } else if ((getParent() instanceof SelectiveRenderer)
- && !((SelectiveRenderer) getParent()).isRendered(this)) {
- return false;
- } else {
- return true;
- }
- }
-
- public boolean isImmediate() {
- if (explicitImmediateValue != null) {
- return explicitImmediateValue;
- } else if (hasListeners(ValueChangeEvent.class)) {
- /*
- * Automatic immediate for fields that developers are interested
- * about.
- */
- return true;
- } else {
- return false;
- }
- }
-
- /**
- * Sets the component's immediate mode to the specified status.
- *
- * @param immediate
- * the boolean value specifying if the component should be in the
- * immediate mode after the call.
- */
- public void setImmediate(boolean immediate) {
- explicitImmediateValue = immediate;
- getState().immediate = immediate;
- }
-
- /*
- * (non-Javadoc)
- *
- * @see com.vaadin.ui.Component#isVisible()
- */
- @Override
- public boolean isVisible() {
- return visible;
- }
-
- /*
- * (non-Javadoc)
- *
- * @see com.vaadin.ui.Component#setVisible(boolean)
- */
- @Override
- public void setVisible(boolean visible) {
- if (isVisible() == visible) {
- return;
- }
-
- this.visible = visible;
- if (visible) {
- /*
- * If the visibility state is toggled from invisible to visible it
- * affects all children (the whole hierarchy) in addition to this
- * component.
- */
- markAsDirtyRecursive();
- }
- if (getParent() != null) {
- // Must always repaint the parent (at least the hierarchy) when
- // visibility of a child component changes.
- getParent().markAsDirty();
- }
- }
-
- /*
- * (non-Javadoc)
- *
- * @see com.vaadin.ui.Component#getDescription()
- */
- @Override
- public String getDescription() {
- return getState(false).description;
- }
-
- /**
- * Sets the component's description. See {@link #getDescription()} for more
- * information on what the description is. This method will trigger a
- * {@link RepaintRequestEvent}.
- *
- * The description is displayed as HTML in tooltips or directly in certain
- * components so care should be taken to avoid creating the possibility for
- * HTML injection and possibly XSS vulnerabilities.
- *
- * @param description
- * the new description string for the component.
- */
- public void setDescription(String description) {
- getState().description = description;
- }
-
- /*
- * Gets the component's parent component. Don't add a JavaDoc comment here,
- * we use the default documentation from implemented interface.
- */
- @Override
- public HasComponents getParent() {
- return parent;
- }
-
- @Override
- public void setParent(HasComponents parent) {
- // If the parent is not changed, don't do anything
- if (parent == null ? this.parent == null : parent.equals(this.parent)) {
- return;
- }
-
- if (parent != null && this.parent != null) {
- throw new IllegalStateException(getClass().getName()
- + " already has a parent.");
- }
-
- // Send a detach event if the component is currently attached
- if (isAttached()) {
- detach();
- }
-
- // Connect to new parent
- this.parent = parent;
-
- // Send attach event if the component is now attached
- if (isAttached()) {
- attach();
- }
- }
-
- /**
- * Returns the closest ancestor with the given type.
- * <p>
- * To find the Window that contains the component, use {@code Window w =
- * getParent(Window.class);}
- * </p>
- *
- * @param <T>
- * The type of the ancestor
- * @param parentType
- * The ancestor class we are looking for
- * @return The first ancestor that can be assigned to the given class. Null
- * if no ancestor with the correct type could be found.
- */
- public <T extends HasComponents> T findAncestor(Class<T> parentType) {
- HasComponents p = getParent();
- while (p != null) {
- if (parentType.isAssignableFrom(p.getClass())) {
- return parentType.cast(p);
- }
- p = p.getParent();
- }
- return null;
- }
-
- /**
- * Gets the error message for this component.
- *
- * @return ErrorMessage containing the description of the error state of the
- * component or null, if the component contains no errors. Extending
- * classes should override this method if they support other error
- * message types such as validation errors or buffering errors. The
- * returned error message contains information about all the errors.
- */
- public ErrorMessage getErrorMessage() {
- return componentError;
- }
-
- /**
- * Gets the component's error message.
- *
- * @link Terminal.ErrorMessage#ErrorMessage(String, int)
- *
- * @return the component's error message.
- */
- public ErrorMessage getComponentError() {
- return componentError;
- }
-
- /**
- * Sets the component's error message. The message may contain certain XML
- * tags, for more information see
- *
- * @link Component.ErrorMessage#ErrorMessage(String, int)
- *
- * @param componentError
- * the new <code>ErrorMessage</code> of the component.
- */
- public void setComponentError(ErrorMessage componentError) {
- this.componentError = componentError;
- fireComponentErrorEvent();
- markAsDirty();
- }
-
- /*
- * Tests if the component is in read-only mode. Don't add a JavaDoc comment
- * here, we use the default documentation from implemented interface.
- */
- @Override
- public boolean isReadOnly() {
- return getState(false).readOnly;
- }
-
- /*
- * Sets the component's read-only mode. Don't add a JavaDoc comment here, we
- * use the default documentation from implemented interface.
- */
- @Override
- public void setReadOnly(boolean readOnly) {
- getState().readOnly = readOnly;
- }
-
- /*
- * Notify the component that it's attached to a window. Don't add a JavaDoc
- * comment here, we use the default documentation from implemented
- * interface.
- */
- @Override
- public void attach() {
- super.attach();
- if (delayedFocus) {
- focus();
- }
- setActionManagerViewer();
- if (locale != null) {
- getUI().getLocaleService().addLocale(locale);
- }
-
- }
-
- /*
- * Detach the component from application. Don't add a JavaDoc comment here,
- * we use the default documentation from implemented interface.
- */
- @Override
- public void detach() {
- super.detach();
- if (actionManager != null) {
- // Remove any existing viewer. UI cast is just to make the
- // compiler happy
- actionManager.setViewer((UI) null);
- }
- }
-
- /**
- * Sets the focus for this component if the component is {@link Focusable}.
- */
- protected void focus() {
- if (this instanceof Focusable) {
- final VaadinSession session = getSession();
- if (session != null) {
- getUI().setFocusedComponent((Focusable) this);
- delayedFocus = false;
- } else {
- delayedFocus = true;
- }
- }
- }
-
- /**
- * Build CSS compatible string representation of height.
- *
- * @return CSS height
- */
- private String getCSSHeight() {
- return getHeight() + getHeightUnits().getSymbol();
- }
-
- /**
- * Build CSS compatible string representation of width.
- *
- * @return CSS width
- */
- private String getCSSWidth() {
- return getWidth() + getWidthUnits().getSymbol();
- }
-
- /**
- * Returns the shared state bean with information to be sent from the server
- * to the client.
- *
- * Subclasses should override this method and set any relevant fields of the
- * state returned by super.getState().
- *
- * @since 7.0
- *
- * @return updated component shared state
- */
- @Override
- protected AbstractComponentState getState() {
- return (AbstractComponentState) super.getState();
- }
-
- @Override
- protected AbstractComponentState getState(boolean markAsDirty) {
- return (AbstractComponentState) super.getState(markAsDirty);
- }
-
- @Override
- public void beforeClientResponse(boolean initial) {
- super.beforeClientResponse(initial);
- // TODO This logic should be on the client side and the state should
- // simply be a data object with "width" and "height".
- if (getHeight() >= 0
- && (getHeightUnits() != Unit.PERCENTAGE || ComponentSizeValidator
- .parentCanDefineHeight(this))) {
- getState().height = "" + getCSSHeight();
- } else {
- getState().height = "";
- }
-
- if (getWidth() >= 0
- && (getWidthUnits() != Unit.PERCENTAGE || ComponentSizeValidator
- .parentCanDefineWidth(this))) {
- getState().width = "" + getCSSWidth();
- } else {
- getState().width = "";
- }
-
- ErrorMessage error = getErrorMessage();
- if (null != error) {
- getState().errorMessage = error.getFormattedHtmlMessage();
- } else {
- getState().errorMessage = null;
- }
-
- getState().immediate = isImmediate();
- }
-
- /* General event framework */
-
- private static final Method COMPONENT_EVENT_METHOD = ReflectTools
- .findMethod(Component.Listener.class, "componentEvent",
- Component.Event.class);
-
- /* Component event framework */
-
- /*
- * Registers a new listener to listen events generated by this component.
- * Don't add a JavaDoc comment here, we use the default documentation from
- * implemented interface.
- */
- @Override
- public void addListener(Component.Listener listener) {
- addListener(Component.Event.class, listener, COMPONENT_EVENT_METHOD);
- }
-
- /*
- * Removes a previously registered listener from this component. Don't add a
- * JavaDoc comment here, we use the default documentation from implemented
- * interface.
- */
- @Override
- public void removeListener(Component.Listener listener) {
- removeListener(Component.Event.class, listener, COMPONENT_EVENT_METHOD);
- }
-
- /**
- * Emits the component event. It is transmitted to all registered listeners
- * interested in such events.
- */
- protected void fireComponentEvent() {
- fireEvent(new Component.Event(this));
- }
-
- /**
- * Emits the component error event. It is transmitted to all registered
- * listeners interested in such events.
- */
- protected void fireComponentErrorEvent() {
- fireEvent(new Component.ErrorEvent(getComponentError(), this));
- }
-
- /**
- * Sets the data object, that can be used for any application specific data.
- * The component does not use or modify this data.
- *
- * @param data
- * the Application specific data.
- * @since 3.1
- */
- public void setData(Object data) {
- applicationData = data;
- }
-
- /**
- * Gets the application specific data. See {@link #setData(Object)}.
- *
- * @return the Application specific data set with setData function.
- * @since 3.1
- */
- public Object getData() {
- return applicationData;
- }
-
- /* Sizeable and other size related methods */
-
- /*
- * (non-Javadoc)
- *
- * @see com.vaadin.Sizeable#getHeight()
- */
- @Override
- public float getHeight() {
- return height;
- }
-
- /*
- * (non-Javadoc)
- *
- * @see com.vaadin.server.Sizeable#getHeightUnits()
- */
- @Override
- public Unit getHeightUnits() {
- return heightUnit;
- }
-
- /*
- * (non-Javadoc)
- *
- * @see com.vaadin.server.Sizeable#getWidth()
- */
- @Override
- public float getWidth() {
- return width;
- }
-
- /*
- * (non-Javadoc)
- *
- * @see com.vaadin.server.Sizeable#getWidthUnits()
- */
- @Override
- public Unit getWidthUnits() {
- return widthUnit;
- }
-
- /*
- * (non-Javadoc)
- *
- * @see com.vaadin.server.Sizeable#setHeight(float, Unit)
- */
- @Override
- public void setHeight(float height, Unit unit) {
- if (unit == null) {
- throw new IllegalArgumentException("Unit can not be null");
- }
- this.height = height;
- heightUnit = unit;
- markAsDirty();
- // ComponentSizeValidator.setHeightLocation(this);
- }
-
- /*
- * (non-Javadoc)
- *
- * @see com.vaadin.server.Sizeable#setSizeFull()
- */
- @Override
- public void setSizeFull() {
- setWidth(100, Unit.PERCENTAGE);
- setHeight(100, Unit.PERCENTAGE);
- }
-
- /*
- * (non-Javadoc)
- *
- * @see com.vaadin.server.Sizeable#setSizeUndefined()
- */
- @Override
- public void setSizeUndefined() {
- setWidthUndefined();
- setHeightUndefined();
- }
-
- /*
- * (non-Javadoc)
- *
- * @see com.vaadin.server.Sizeable#setWidthUndefined()
- */
- @Override
- public void setWidthUndefined() {
- setWidth(-1, Unit.PIXELS);
- }
-
- /*
- * (non-Javadoc)
- *
- * @see com.vaadin.server.Sizeable#setHeightUndefined()
- */
- @Override
- public void setHeightUndefined() {
- setHeight(-1, Unit.PIXELS);
- }
-
- /*
- * (non-Javadoc)
- *
- * @see com.vaadin.server.Sizeable#setWidth(float, Unit)
- */
- @Override
- public void setWidth(float width, Unit unit) {
- if (unit == null) {
- throw new IllegalArgumentException("Unit can not be null");
- }
- this.width = width;
- widthUnit = unit;
- markAsDirty();
- // ComponentSizeValidator.setWidthLocation(this);
- }
-
- /*
- * (non-Javadoc)
- *
- * @see com.vaadin.server.Sizeable#setWidth(java.lang.String)
- */
- @Override
- public void setWidth(String width) {
- Size size = parseStringSize(width);
- if (size != null) {
- setWidth(size.getSize(), size.getUnit());
- } else {
- setWidth(-1, Unit.PIXELS);
- }
- }
-
- /*
- * (non-Javadoc)
- *
- * @see com.vaadin.server.Sizeable#setHeight(java.lang.String)
- */
- @Override
- public void setHeight(String height) {
- Size size = parseStringSize(height);
- if (size != null) {
- setHeight(size.getSize(), size.getUnit());
- } else {
- setHeight(-1, Unit.PIXELS);
- }
- }
-
- /*
- * (non-Javadoc)
- *
- * @see
- * com.vaadin.ui.DesignSynchronizable#synchronizeFromDesign(org.jsoup.nodes
- * .Node, com.vaadin.ui.declarative.DesignContext)
- */
- @Override
- public void synchronizeFromDesign(Node design, DesignContext designContext) {
- Attributes attr = design.attributes();
- DesignSynchronizable def = designContext.getDefaultInstance(this
- .getClass());
- // handle default attributes
- for (String property : getDefaultAttributes()) {
- String value = null;
- if (attr.hasKey(property)) {
- value = attr.get(property);
- }
- DesignAttributeHandler.assignAttribute(this, property, value, def);
- }
- // handle width and height
- DesignAttributeHandler.assignWidth(this, attr, def);
- DesignAttributeHandler.assignHeight(this, attr, def);
- }
-
- /**
- * Returns the list of attributes that do not require custom handling when
- * synchronizing from design. These are typically attributes of some
- * primitive type. The default implementation searches setters with
- * primitive values
- *
- * @since 7.4
- * @return the list of attributes that can be synchronized from design using
- * the default approach.
- */
- protected List<String> getDefaultAttributes() {
- List<String> attributes = DesignAttributeHandler
- .findSupportedAttributes(this.getClass());
- // we want to handle width and height in a custom way
- attributes.remove("width");
- attributes.remove("height");
- attributes.remove("debug-id");
- return attributes;
- }
-
- /*
- * (non-Javadoc)
- *
- * @see
- * com.vaadin.ui.DesignSynchronizable#synchronizeToDesign(org.jsoup.nodes
- * .Node, com.vaadin.ui.declarative.DesignContext)
- */
- @Override
- public void synchronizeToDesign(Node design, DesignContext designContext) {
- AbstractComponent def = designContext.getDefaultInstance(this
- .getClass());
-
- }
-
- /*
- * Returns array with size in index 0 unit in index 1. Null or empty string
- * will produce {-1,Unit#PIXELS}
- */
- private static Size parseStringSize(String s) {
- if (s == null) {
- return null;
- }
- s = s.trim();
- if ("".equals(s)) {
- return null;
- }
- float size = 0;
- Unit unit = null;
- Matcher matcher = sizePattern.matcher(s);
- if (matcher.find()) {
- size = Float.parseFloat(matcher.group(1));
- if (size < 0) {
- size = -1;
- unit = Unit.PIXELS;
- } else {
- String symbol = matcher.group(2);
- unit = Unit.getUnitFromSymbol(symbol);
- }
- } else {
- throw new IllegalArgumentException("Invalid size argument: \"" + s
- + "\" (should match " + sizePattern.pattern() + ")");
- }
- return new Size(size, unit);
- }
-
- private static class Size implements Serializable {
- float size;
- Unit unit;
-
- public Size(float size, Unit unit) {
- this.size = size;
- this.unit = unit;
- }
-
- public float getSize() {
- return size;
- }
-
- public Unit getUnit() {
- return unit;
- }
- }
-
- /*
- * Actions
- */
-
- /**
- * Gets the {@link ActionManager} used to manage the
- * {@link ShortcutListener}s added to this {@link Field}.
- *
- * @return the ActionManager in use
- */
- protected ActionManager getActionManager() {
- if (actionManager == null) {
- actionManager = new ConnectorActionManager(this);
- setActionManagerViewer();
- }
- return actionManager;
- }
-
- /**
- * Set a viewer for the action manager to be the parent sub window (if the
- * component is in a window) or the UI (otherwise). This is still a
- * simplification of the real case as this should be handled by the parent
- * VOverlay (on the client side) if the component is inside an VOverlay
- * component.
- */
- private void setActionManagerViewer() {
- if (actionManager != null && getUI() != null) {
- // Attached and has action manager
- Window w = findAncestor(Window.class);
- if (w != null) {
- actionManager.setViewer(w);
- } else {
- actionManager.setViewer(getUI());
- }
- }
-
- }
-
- public void addShortcutListener(ShortcutListener shortcut) {
- getActionManager().addAction(shortcut);
- }
-
- public void removeShortcutListener(ShortcutListener shortcut) {
- if (actionManager != null) {
- actionManager.removeAction(shortcut);
- }
- }
-
- /**
- * Determine whether a <code>content</code> component is equal to, or the
- * ancestor of this component.
- *
- * @param content
- * the potential ancestor element
- * @return <code>true</code> if the relationship holds
- */
- protected boolean isOrHasAncestor(Component content) {
- if (content instanceof HasComponents) {
- for (Component parent = this; parent != null; parent = parent
- .getParent()) {
- if (parent.equals(content)) {
- return true;
- }
- }
- }
- return false;
- }
- }
|