com.github.ilyes4j.gwt.mdl.components

Class MdlGwtUtils

java.lang.Object

com.github.ilyes4j.gwt.mdl.components.MdlGwtUtils

public final class MdlGwtUtils
extends Object

Contains general purpose and recurring code snippet used through out the project. This class centralizes all these procedures to avoid code duplication and redundancy.

Author:

Mohamed Ilyes DIMASSI

Field Summary

Fields

Modifier and Type	Field and Description
static String	DISABLED The disabled property name.

Method Summary

Methods

Modifier and Type	Method and Description
static void	addClass(com.google.gwt.dom.client.Element element, Object style)
static void	addStyle(com.google.gwt.user.client.ui.UIObject object, Object style) When UIObject.addStyleName(String) is invoked with an empty style name, it raises an exception.
static void	assertIndex(int size, int index) Make sure the index provided as input is inside the range of possible elements of a list.
static double	getProperty(com.google.gwt.dom.client.Element elt, String prop) Retrieve the property value for an element.
static void	insureId(com.google.gwt.dom.client.Element element) Makes sure the element parameter have an id.
static boolean	mouseOutOfBounds(com.google.gwt.dom.client.Element element, int x, int y) Is the mouse out of the element bounds.
static void	removeClass(com.google.gwt.dom.client.Element element, Object style) Same behavior as removeStyle(UIObject, Object) applied to Element.
static void	removeStyle(com.google.gwt.user.client.ui.UIObject object, Object style) Same behavior as addStyle(UIObject, Object) but for UIObject.removeStyleName(String).
static void	setEnabled(com.google.gwt.dom.client.Element elt, boolean enabled) apply the disabled property for a DOM element if the element should be disabled.
static void	setFor(com.google.gwt.dom.client.Element element, String value) Helper method that sets the value to the "for" attribute in a DOM element.
static void	setProperty(com.google.gwt.dom.client.Element elt, String prop, double val) Set the property for a DOM element object, not to be confused with element attributes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DISABLED

public static final String DISABLED

The disabled property name.

See Also:

Constant Field Values

Method Detail

setEnabled

public static void setEnabled(com.google.gwt.dom.client.Element elt,
              boolean enabled)

apply the disabled property for a DOM element if the element should be disabled.

Parameters:

elt - the target element

enabled - true to remove the disabled property and false to add it

insureId

public static void insureId(com.google.gwt.dom.client.Element element)

Makes sure the element parameter have an id. If the element contains an id, then nothing happens, otherwise, the element is provided with a generated unique id.

Parameters:

element - the element for which an id should be insured

setFor

public static void setFor(com.google.gwt.dom.client.Element element,
          String value)

Helper method that sets the value to the "for" attribute in a DOM element. This attribute helps wiring parts together inside an mdl component and also binds mdl components together. The "for" indicates that the the embedding element is referencing another element in the component. The value of the "for" attribute is the id of the referenced element.

Parameters:

element - the target element to be processed

value - the value tobe set to the "for" attribute

setProperty

public static void setProperty(com.google.gwt.dom.client.Element elt,
               String prop,
               double val)

Set the property for a DOM element object, not to be confused with element attributes.

To distinguish between properties and attributes lets consider the following input element :
<input id="inrang" type="range" min="0" max="100">

The current value is set through the value PROPERTY => inrang["value"] = 50;
The initial value is set using the value ATTRIBUTE => inrang.setAttribute("value", 0);

Parameters:

elt - the target element

prop - the target property

val - the target value

getProperty

public static double getProperty(com.google.gwt.dom.client.Element elt,
                 String prop)

Retrieve the property value for an element.

Parameters:

elt - the target element of the value set

prop - the target property to set

Returns:

the value of the property being set

assertIndex

public static void assertIndex(int size,
               int index)

Make sure the index provided as input is inside the range of possible elements of a list.

Parameters:

size - the size of the list

index - the index to be checked

addStyle

public static void addStyle(com.google.gwt.user.client.ui.UIObject object,
            Object style)

When UIObject.addStyleName(String) is invoked with an empty style name, it raises an exception. In mdl, the absence of a selector is interpreted as the default option for the behavior. For this reason, we need an alternative to UIObject.addStyleName(String) that does not raise an exception when it encounter an empty css selector.

Parameters:

object - the widget to which the css selector will be applied

style - any Object with a Object.toString() method returning the css selector to be applied.

removeStyle

public static void removeStyle(com.google.gwt.user.client.ui.UIObject object,
               Object style)

Same behavior as addStyle(UIObject, Object) but for UIObject.removeStyleName(String).

Parameters:

object - the widget to which the css selector will be applied

style - any Object with a Object.toString() method returning the css selector to be applied.

See Also:

addStyle(UIObject, Object)

addClass

public static void addClass(com.google.gwt.dom.client.Element element,
            Object style)

Parameters:

element - the Element to which the css class will be applied

style - any Object with a Object.toString() method returning the css class to be applied.

See Also:

assertStyle(Object, Object)

removeClass

public static void removeClass(com.google.gwt.dom.client.Element element,
               Object style)

Same behavior as removeStyle(UIObject, Object) applied to Element.

Parameters:

element - the Element to which the css selector will be applied

style - any Object with a Object.toString() method returning the css selector to be applied.

mouseOutOfBounds

public static boolean mouseOutOfBounds(com.google.gwt.dom.client.Element element,
                       int x,
                       int y)

Is the mouse out of the element bounds.

Parameters:

element - the target element

x - the horizontal absolute position of the mouse

y - the vertical absolute position of the mouse

Returns:

true if the mouse out of the element bounds