Package com.vaadin.client

Class Util

  • public class Util
extends Object

    • Constructor Detail

      • Util

        public Util()

    • Method Detail

      • browserDebugger

        @Deprecated
public static void browserDebugger()
        Deprecated.
        As of 7.4.0, use WidgetUtil.browserDebugger() instead.
        Helper method for debugging purposes. Stops execution on firefox browsers on a breakpoint.

      • getKeyCode

        @Deprecated
public static int getKeyCode​(com.google.gwt.event.dom.client.KeyEvent<?> event)
        Deprecated.
        As of 7.4.0, use WidgetUtil.getKeyCode(KeyEvent) instead.
        Helper method for a bug fix #14041. For mozilla getKeyCode return 0 for space bar (because space is considered as char). If return 0 use getCharCode.
        Parameters:
        event -
        Returns:
        return key code
        Since:
        7.2.4

      • getElementFromPoint

        @Deprecated
public static com.google.gwt.user.client.Element getElementFromPoint​(int clientX,
                                                                     int clientY)
        Deprecated.
        As of 7.4.0, use WidgetUtil.getElementFromPoint(int, int) instead.
        Returns the topmost element of from given coordinates. TODO fix crossplat issues clientX vs pageX. See quircksmode. Not critical for vaadin as we scroll div istead of page.
        Parameters:
        x -
        y -
        Returns:
        the element at given coordinates

      • notifyParentOfSizeChange

        @Deprecated
public static void notifyParentOfSizeChange​(com.google.gwt.user.client.ui.Widget widget,
                                            boolean lazy)
        Deprecated.
        As of 7.0, use LayoutManager.setNeedsMeasure(ComponentConnector) instead
        This helper method can be called if components size have been changed outside rendering phase. It notifies components parent about the size change so it can react. When using this method, developer should consider if size changes could be notified lazily. If lazy flag is true, method will save widget and wait for a moment until it notifies parents in chunks. This may vastly optimize layout in various situation. Example: if component have a lot of images their onload events may fire "layout phase" many times in a short period.
        Parameters:
        widget -
        lazy - run componentSizeUpdated lazyly

      • findConnectorFor

        public static ComponentConnector findConnectorFor​(com.google.gwt.user.client.ui.Widget widget)

      • escapeAttribute

        @Deprecated
public static String escapeAttribute​(String attribute)
        Deprecated.
        As of 7.4.0, use WidgetUtil.escapeAttribute(String) instead.
        Escapes the string so it is safe to write inside an HTML attribute.
        Parameters:
        attribute - The string to escape
        Returns:
        An escaped version of attribute.

      • cloneNode

        @Deprecated
public static com.google.gwt.user.client.Element cloneNode​(com.google.gwt.dom.client.Element element,
                                                           boolean deep)
        Deprecated.
        As of 7.4.0, use WidgetUtil.cloneNode(Element, boolean) instead.
        Clones given element as in JavaScript. Deprecate this if there appears similar method into GWT someday.
        Parameters:
        element -
        deep - clone child tree also
        Returns:

      • runWebkitOverflowAutoFix

        @Deprecated
public static void runWebkitOverflowAutoFix​(com.google.gwt.dom.client.Element elem)
        Deprecated.
        As of 7.4.0, use WidgetUtil.runWebkitOverflowAutoFix(Element) instead.
        Run workaround for webkits overflow auto issue. See: our bug #2138 and https://bugs.webkit.org/show_bug.cgi?id=21462
        Parameters:
        elem - with overflow auto

      • parseRelativeSize

        public static RenderInformation.FloatSize parseRelativeSize​(AbstractComponentState state)
        Parses shared state and fetches the relative size of the component. If a dimension is not specified as relative it will return -1. If the shared state does not contain width or height specifications this will return null.
        Parameters:
        state -
        Returns:

      • isCached

        @Deprecated
public static boolean isCached​(UIDL uidl)
        Deprecated.

      • equals

        @Deprecated
public static boolean equals​(Object a,
                             Object b)
        Deprecated.
        As of 7.1 use Object.equals(Object) instead
        Checks if a and b are equals using Object.equals(Object). Handles null values as well. Does not ensure that objects are of the same type. Assumes that the first object's equals method handle equals properly.
        Parameters:
        a - The first value to compare
        b - The second value to compare
        Returns:

      • updateRelativeChildrenAndSendSizeUpdateEvent

        public static void updateRelativeChildrenAndSendSizeUpdateEvent​(ApplicationConnection client,
                                                                com.google.gwt.user.client.ui.HasWidgets container,
                                                                com.google.gwt.user.client.ui.Widget widget)

      • getRequiredWidth

        @Deprecated
public static int getRequiredWidth​(com.google.gwt.dom.client.Element element)
        Deprecated.
        As of 7.4.0, use WidgetUtil.getRequiredWidth(Element) instead.
        Gets the border-box width for the given element, i.e. element width + border + padding. Always rounds up to nearest integer.
        Parameters:
        element - The element to check
        Returns:
        The border-box width for the element

      • getRequiredHeight

        @Deprecated
public static int getRequiredHeight​(com.google.gwt.dom.client.Element element)
        Deprecated.
        As of 7.4.0, use WidgetUtil.getRequiredHeight(Element) instead.
        Gets the border-box height for the given element, i.e. element height + border + padding. Always rounds up to nearest integer.
        Parameters:
        element - The element to check
        Returns:
        The border-box height for the element

      • mayHaveScrollBars

        @Deprecated
public static boolean mayHaveScrollBars​(com.google.gwt.dom.client.Element pe)
        Deprecated.
        As of 7.4.0, use WidgetUtil.mayHaveScrollBars(Element) instead.
        Detects what is currently the overflow style attribute in given element.
        Parameters:
        pe - the element to detect
        Returns:
        true if auto or scroll

      • getConnectorForElement

        public static ComponentConnector getConnectorForElement​(ApplicationConnection client,
                                                        com.google.gwt.user.client.ui.Widget parent,
                                                        com.google.gwt.dom.client.Element element)
        Locates the nested child component of parent which contains the element element. The child component is also returned if "element" is part of its caption. If element is not part of any child component, null is returned. This method returns the deepest nested VPaintableWidget.
        Parameters:
        client - A reference to ApplicationConnection
        parent - The widget that contains element.
        element - An element that is a sub element of the parent
        Returns:
        The VPaintableWidget which the element is a part of. Null if the element does not belong to a child.

      • focus

        @Deprecated
public static void focus​(com.google.gwt.dom.client.Element el)
        Deprecated.
        As of 7.4.0, use WidgetUtil.focus(Element) instead.
        Will (attempt) to focus the given DOM Element.
        Parameters:
        el - the element to focus

      • findPaintable

        public static ComponentConnector findPaintable​(ApplicationConnection client,
                                               com.google.gwt.dom.client.Element element)
        Helper method to find the nearest parent paintable instance by traversing the DOM upwards from given element.
        Parameters:
        element - the element to start from

      • findWidget

        @Deprecated
public static <T> T findWidget​(com.google.gwt.dom.client.Element element,
                               Class<? extends com.google.gwt.user.client.ui.Widget> class1)
        Deprecated.
        As of 7.4.0, use WidgetUtil.findWidget(Element, Class) instead.
        Helper method to find first instance of given Widget type found by traversing DOM upwards from given element.
        Parameters:
        element - the element where to start seeking of Widget
        class1 - the Widget type to seek for

      • forceWebkitRedraw

        @Deprecated
public static void forceWebkitRedraw​(com.google.gwt.dom.client.Element element)
        Deprecated.
        As of 7.4.0, use WidgetUtil.forceWebkitRedraw(Element) instead.
        Force webkit to redraw an element
        Parameters:
        element - The element that should be redrawn

      • forceIE8Redraw

        @Deprecated
public static final void forceIE8Redraw​(com.google.gwt.dom.client.Element e)
        Deprecated.
        As of 7.4.0, use WidgetUtil.forceIE8Redraw(Element) instead.
        Performs a hack to trigger a re-layout in the IE8. This is usually necessary in cases where IE8 "forgets" to update child elements when they resize.
        Parameters:
        e - The element to perform the hack on

      • forceIERedraw

        @Deprecated
public static void forceIERedraw​(com.google.gwt.dom.client.Element e)
        Deprecated.
        As of 7.4.0, use WidgetUtil.forceIERedraw(Element) instead.
        Performs a hack to trigger a re-layout in the IE browser. This is usually necessary in cases where IE "forgets" to update child elements when they resize.
        Parameters:
        e - The element to perform the hack on
        Since:
        7.3

      • detachAttach

        @Deprecated
public static void detachAttach​(com.google.gwt.dom.client.Element element)
        Deprecated.
        As of 7.4.0, use WidgetUtil.detachAttach(Element) instead.
        Detaches and re-attaches the element from its parent. The element is reattached at the same position in the DOM as it was before. Does nothing if the element is not attached to the DOM.
        Parameters:
        element - The element to detach and re-attach

      • getChildElementIndex

        @Deprecated
public static int getChildElementIndex​(com.google.gwt.dom.client.Element childElement)
        Deprecated.
        As of 7.4.0, use WidgetUtil.getChildElementIndex(Element) instead.
        Returns the index of the childElement within its parent.
        Parameters:
        subElement -
        Returns:

      • setStyleTemporarily

        @Deprecated
public static void setStyleTemporarily​(com.google.gwt.dom.client.Element element,
                                       String styleProperty,
                                       String tempValue)
        Deprecated.
        As of 7.4.0, use WidgetUtil.setStyleTemporarily(Element, String, String) instead.
        Temporarily sets the styleProperty to tempValue and then resets it to its current value. Used mainly to work around rendering issues in IE (and possibly in other browsers)
        Parameters:
        element - The target element
        styleProperty - The name of the property to set
        tempValue - The temporary value

      • getTouchOrMouseClientX

        @Deprecated
public static int getTouchOrMouseClientX​(com.google.gwt.user.client.Event event)
        Deprecated.
        As of 7.4.0, use WidgetUtil.getTouchOrMouseClientX(Event) instead.
        A helper method to return the client position from an event. Returns position from either first changed touch (if touch event) or from the event itself.
        Parameters:
        event -
        Returns:

      • getElementUnderMouse

        @Deprecated
public static com.google.gwt.user.client.Element getElementUnderMouse​(com.google.gwt.dom.client.NativeEvent event)
        Deprecated.
        As of 7.4.0, use WidgetUtil.getElementUnderMouse(NativeEvent) instead.
        Find the element corresponding to the coordinates in the passed mouse event. Please note that this is not always the same as the target of the event e.g. if event capture is used.
        Parameters:
        event - the mouse event to get coordinates from
        Returns:
        the element at the coordinates of the event

      • getTouchOrMouseClientY

        @Deprecated
public static int getTouchOrMouseClientY​(com.google.gwt.user.client.Event event)
        Deprecated.
        As of 7.4.0, use WidgetUtil.getTouchOrMouseClientY(Event) instead.
        A helper method to return the client position from an event. Returns position from either first changed touch (if touch event) or from the event itself.
        Parameters:
        event -
        Returns:

      • getFocusedElement

        @Deprecated
public static com.google.gwt.user.client.Element getFocusedElement()
        Deprecated.
        As of 7.4.0, use WidgetUtil.getFocusedElement() instead.
        Gets the currently focused element.
        Returns:
        The active element or null if no active element could be found.

      • getIEFocusedElement

        @Deprecated
public static com.google.gwt.user.client.Element getIEFocusedElement()
        Deprecated.
        Use #getFocusedElement instead
        Gets the currently focused element for Internet Explorer.
        Returns:
        The currently focused element

      • isFocusedElementEditable

        @Deprecated
public static boolean isFocusedElementEditable()
        Deprecated.
        As of 7.4.0, use WidgetUtil.isFocusedElementEditable() instead.
        Gets currently focused element and checks if it's editable
        Returns:
        true if focused element is editable
        Since:
        7.4

      • isAttachedAndDisplayed

        @Deprecated
public static boolean isAttachedAndDisplayed​(com.google.gwt.user.client.ui.Widget widget)
        Deprecated.
        As of 7.4.0, use WidgetUtil.isAttachedAndDisplayed(Widget) instead.
        Kind of stronger version of isAttached(). In addition to std isAttached, this method checks that this widget nor any of its parents is hidden. Can be e.g used to check whether component should react to some events or not.
        Parameters:
        widget -
        Returns:
        true if attached and displayed

      • scrollIntoViewVertically

        @Deprecated
public static void scrollIntoViewVertically​(com.google.gwt.dom.client.Element elem)
        Deprecated.
        As of 7.4.0, use WidgetUtil.scrollIntoViewVertically(Element) instead.
        Scrolls an element into view vertically only. Modified version of Element.scrollIntoView.
        Parameters:
        elem - The element to scroll into view

      • isTouchEventOrLeftMouseButton

        @Deprecated
public static boolean isTouchEventOrLeftMouseButton​(com.google.gwt.user.client.Event event)
        Deprecated.
        As of 7.4.0, use WidgetUtil.isTouchEventOrLeftMouseButton(Event) instead.
        Checks if the given event is either a touch event or caused by the left mouse button
        Parameters:
        event -
        Returns:
        true if the event is a touch event or caused by the left mouse button, false otherwise

      • collectionsEquals

        public static boolean collectionsEquals​(Collection<?> collection1,
                                        Collection<?> collection2)
        Performs a shallow comparison of the collections.
        Parameters:
        collection1 - The first collection
        collection2 - The second collection
        Returns:
        true if the collections contain the same elements in the same order, false otherwise

      • getAbsoluteUrl

        @Deprecated
public static String getAbsoluteUrl​(String url)
        Deprecated.
        As of 7.4.0, use WidgetUtil.getAbsoluteUrl(String) instead.
        Resolve a relative URL to an absolute URL based on the current document's location.
        Parameters:
        url - a string with the relative URL to resolve
        Returns:
        the corresponding absolute URL as a string

      • setSelectionRange

        @Deprecated
public static void setSelectionRange​(com.google.gwt.dom.client.Element elem,
                                     int pos,
                                     int length,
                                     String direction)
        Deprecated.
        As of 7.4.0, use WidgetUtil.setSelectionRange(Element, int, int, String) instead.
        Sets the selection range of an input element. We need this JSNI function to set selection range so that we can use the optional direction attribute to set the anchor to the end and the focus to the start. This makes Firefox work the same way as other browsers (#13477)
        Parameters:
        elem - the html input element.
        pos - the index of the first selected character.
        length - the selection length.
        direction - a string indicating the direction in which the selection was performed. This may be "forward" or "backward", or "none" if the direction is unknown or irrelevant.
        Since:
        7.3

      • jso2json

        public static <T extends JsonValue> T jso2json​(com.google.gwt.core.client.JavaScriptObject jso)
        Converts a native JavaScriptObject into a JsonValue. This is a no-op in GWT code compiled to javascript, but needs some special handling to work when run in JVM.
        Parameters:
        jso - the java script object to represent as json
        Returns:
        the json representation

      • json2jso

        public static com.google.gwt.core.client.JavaScriptObject json2jso​(JsonValue jsonValue)
        Converts a JsonValue into a native JavaScriptObject. This is a no-op in GWT code compiled to javascript, but needs some special handling to work when run in JVM.
        Parameters:
        jsonValue - the json value
        Returns:
        a native javascript object representation of the json value

      • parse

        public static <T extends com.google.gwt.core.client.JavaScriptObject> T parse​(String jsonAsString)
        Parse a string containing JSON into a JavaScriptObject.
        Type Parameters:
        T - the overlay type to expect from the parse
        Parameters:
        jsonAsString -
        Returns:
        a JavaScript object constructed from the parse

      • round

        public static double round​(double num,
                           int exp)
        Round num up to exp decimal positions.
        Since:
        7.6

      • shouldSkipMeasurementOfConnector

        public static boolean shouldSkipMeasurementOfConnector​(ComponentConnector candidate,
                                                       ComponentConnector parent)
        Test if we can can skip measuring this connector. We can skip the measurement if its parent is a ChildMeasureHintConnector and has an appropriate mode set. For internal use only. May be removed or replaced in the future.

      • shouldSkipMeasurementOfConnector

        public static boolean shouldSkipMeasurementOfConnector​(ComponentConnector candidate)
        Test if we can can skip measuring this connector. We can skip the measurement if its parent is a ChildMeasureHintConnector and has an appropriate mode set. This version of the method tries to recursively locate such a parent. For internal use only. May be removed or replaced in the future.