org.fireweb

Class Utils

java.lang.Object

org.fireweb.Utils

public final class Utils
extends java.lang.Object

Utility methods for internal use

Version:

3.0

Author:

Piotr Ptak

Constructor Summary

Constructors

Constructor and Description
Utils()

Method Summary

Modifier and Type	Method and Description
static boolean	areEquals(java.lang.Object a, java.lang.Object b) Compare two objects
(package private) static <A extends java.lang.annotation.Annotation> void	callAnnotatedMethod(java.lang.Object object, java.lang.Class<A> annotationType) Call annotated method method.
(package private) static void	callInitDragDrop(Element ele) Draw drag event JS Constants.DRAG_BROWSER_EVENT listener of Element
(package private) static java.lang.String	drawEventHTML(EventListener listener, Element element, boolean innerHTML) This method is calling when html is drawing.
(package private) static java.lang.String	drawEventScript(EventListener listener, Element element) This method is calling when we add listener after html drawing - the object exist at browser.
(package private) static void	drawHTML(Element we, boolean innerHTMLtoJS, boolean drawIntro) drawing HTML view below elements of this element in tree.
(package private) static java.lang.String	drawInitDragDrop(Element ele) Draw DragDrop initialisation JS string.
static java.lang.String	encodeScript(java.lang.String script) Encoding JS in order to convert extra characters to ascii Replace + to %20 which is right decoded by JS function "decodeURIComponent".
static java.lang.String	escapeHTML(java.lang.String aTagFragment) Replace characters having special meaning inside HTML tags with their escaped equivalents, using character entities such as '&'.
static java.lang.String	escapeNestedScript(java.lang.String js) Escapes string to right JavaScript literals for inline scripts as correct nested in string.
static java.lang.StringBuilder	escapeScript(java.lang.String js) Escapes string to right JavaScript literals.
static java.lang.StringBuilder	escapeScriptWhiteSpaces(java.lang.String js) Escapes white spaces in JavaScripts for inline scripts.
(package private) static <A extends java.lang.annotation.Annotation> A	findAnnotation(java.lang.Object object, java.lang.Class<A> annotationType) Search for annotation in inheritance hierarchy.
static Element	findElement(Element current, java.lang.String objectId) Find web object in elements tree.
static <T extends Element> T	findParent(java.lang.Class<T> c, Element curr) Looking in object tree parent object of given class type.
(package private) static java.lang.String	getScriptInnerHTML(Element e) Returns innerHTML prefix of Element.
static java.lang.String	getScriptPrefix(Element e) Returns prefix of FireWeb element selector
static java.lang.String	pathToDebugScript(java.lang.String orginPath) Change path to script by add "-debug" suffix to it's name.
static Color	rgb(int red, int green, int blue) Create color from RGB
static java.lang.Integer	rgbToInt(int red, int green, int blue) Convert RGB to integer value.
static java.lang.Boolean	toBool(java.lang.String s) Converts JavaScript String to Boolean.
static java.lang.Integer	toInt(java.lang.String s) Converts JavaScript String to Integer.
(package private) static void	write(java.lang.String s) Standard to browser printer

Methods inherited from class java.lang.Object

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

Constructor Detail

Utils

public Utils()

Method Detail

getScriptInnerHTML

static final java.lang.String getScriptInnerHTML(Element e)

Returns innerHTML prefix of Element.

Parameters:

e - Element to build the prefix

Returns:

The prefix string

drawEventHTML

static final java.lang.String drawEventHTML(EventListener listener,
                                            Element element,
                                            boolean innerHTML)

This method is calling when html is drawing.
Server events are drawing with "FW.pr"
Browser (client) events are drawing with "FW.prb"
Not browser events such "confirm", "prompt", "draw" etc. are excluded.
if event implements CustomEventListener interface the
disableEventUserJavaScript method is called.

Parameters:

listener - of event to draw

element - to draw

innerHTML - if inner text

Returns:

JS expression to set event method on web object (HTML element)

drawEventScript

static final java.lang.String drawEventScript(EventListener listener,
                                              Element element)

This method is calling when we add listener after html drawing - the object exist at browser.
Server events are drawing with "FW.pr"
Browser (client) events are drawing with "FW.prb"
Not browser events such "confirm", "prompt", "draw" etc. are excluded.
if event implements CustomEventListener interface the
enableEventUserJavaScript method is calling.

Parameters:

listener - event to draw

element - element to draw

Returns:

JS expression to fill event method on web object (HTML element)

drawHTML

static final void drawHTML(Element we,
                           boolean innerHTMLtoJS,
                           boolean drawIntro)

drawing HTML view below elements of this element in tree. Generate HTML view of the elementType. Before start drawing OnDraw event is called. Setting object status to "None"

Parameters:

we - Element to draw

innerHTMLtoJS - True - if call is from AJAX, then we have to escape inner text for JavaScript. False if call from HTML request when we don't have to escape for JavaScript

drawIntro - True if draw intro of HTML code form Servlet false in other cases

Throws:

FireWebException - if element type is null.

drawInitDragDrop

static final java.lang.String drawInitDragDrop(Element ele)

Draw DragDrop initialisation JS string.

Parameters:

ele - Element to get the string

Returns:

String contains JS of event Constants.DRAG_BROWSER_EVENT

callInitDragDrop

static final void callInitDragDrop(Element ele)

Draw drag event JS Constants.DRAG_BROWSER_EVENT listener of Element

Parameters:

ele - The element

write

static final void write(java.lang.String s)

Standard to browser printer

Parameters:

s - String to send to browser

findAnnotation

static final <A extends java.lang.annotation.Annotation> A findAnnotation(java.lang.Object object,
                                                                          java.lang.Class<A> annotationType)

Search for annotation in inheritance hierarchy.

Type Parameters:

A - annotation type to find

Parameters:

object - Object instance

annotationType - Annotation type to looking up.

Returns:

found annotation or null if not found

callAnnotatedMethod

static final <A extends java.lang.annotation.Annotation> void callAnnotatedMethod(java.lang.Object object,
                                                                                  java.lang.Class<A> annotationType)

Call annotated method method.

Type Parameters:

A - annotation type to find

Parameters:

object - to call method

annotationType - annotation to find

escapeHTML

public static final java.lang.String escapeHTML(java.lang.String aTagFragment)

Replace characters having special meaning inside HTML tags with their escaped equivalents, using character entities such as '&'.

The escaped characters are :

• <
• >
• "
• '
• \
• &

Parameters:

aTagFragment - to escape

Returns:

escaped string

escapeScript

public static final java.lang.StringBuilder escapeScript(java.lang.String js)

Escapes string to right JavaScript literals.

Parameters:

js - String to escape

Returns:

Escaped string

escapeNestedScript

public static final java.lang.String escapeNestedScript(java.lang.String js)

Escapes string to right JavaScript literals for inline scripts as correct nested in string.

Parameters:

js - String to escape

Returns:

Escaped string

escapeScriptWhiteSpaces

public static final java.lang.StringBuilder escapeScriptWhiteSpaces(java.lang.String js)

Escapes white spaces in JavaScripts for inline scripts.

Parameters:

js - String to escape

Returns:

Escaped string

encodeScript

public static final java.lang.String encodeScript(java.lang.String script)

Encoding JS in order to convert extra characters to ascii Replace + to %20 which is right decoded by JS function "decodeURIComponent". Without that in Script each space is converted to + sign.

Parameters:

script - The script to convert

Returns:

Converted script

getScriptPrefix

public static final java.lang.String getScriptPrefix(Element e)

Returns prefix of FireWeb element selector

Parameters:

e - Element to build the prefix

Returns:

The prefix string

findElement

public static final Element findElement(Element current,
                                        java.lang.String objectId)

Find web object in elements tree.

Parameters:

current - the root for searching

objectId - Object id to find

Returns:

found element or null

findParent

public static final <T extends Element> T findParent(java.lang.Class<T> c,
                                                     Element curr)

Looking in object tree parent object of given class type.

Type Parameters:

T - type of element

Parameters:

c - Class to find

curr - The object for which we looking of root object - starting point.

Returns:

found element or null

toInt

public static final java.lang.Integer toInt(java.lang.String s)

Converts JavaScript String to Integer.

Parameters:

s - String to convert

Returns:

Integer or null if string equals to JS_UNDEFINED

toBool

public static final java.lang.Boolean toBool(java.lang.String s)

Converts JavaScript String to Boolean.

Parameters:

s - String to convert

Returns:

Boolean or null if string equals to JS_UNDEFINED

rgbToInt

public static final java.lang.Integer rgbToInt(int red,
                                               int green,
                                               int blue)

Convert RGB to integer value.

Parameters:

red - color level

green - color level

blue - color level

Returns:

Integer value of RGB

rgb

public static final Color rgb(int red,
                              int green,
                              int blue)

Create color from RGB

Parameters:

red - color level

green - color level

blue - color level

Returns:

Color of RGB

areEquals

public static final boolean areEquals(java.lang.Object a,
                                      java.lang.Object b)

Compare two objects

Parameters:

a - Object to compare

b - Object to compare

Returns:

True if object are equals

pathToDebugScript

public static final java.lang.String pathToDebugScript(java.lang.String orginPath)

Change path to script by add "-debug" suffix to it's name.
Example:

 From script.js to script-debug.js
 

Parameters:

orginPath - path to non debug form script (compressed)

Returns:

Path to human readable script.