org.fireweb

Class Utils

java.lang.Object

org.fireweb.Utils

public final class Utils
extends java.lang.Object

Utility methods for internal use

Version:

4.0

Author:

Piotr Ptak

Constructor Summary

Constructors

Constructor and Description
Utils()

Method Summary

Modifier and Type	Method and Description
static boolean	annotationOptionEquals(java.lang.annotation.Annotation a1, java.lang.annotation.Annotation a2) Event options comparator
static boolean	areEquals(java.lang.Object a, java.lang.Object b) Compare two objects
static java.lang.String	capitalizeFirstLetter(java.lang.String original) Utility method for generating getters name of annotated attributes.
static int	codeEventOptions(java.util.Set<java.lang.annotation.Annotation> options) Computes browser event options value
static void	drawAttribute(java.lang.String attrName, java.lang.Object attrValue, boolean marker, java.lang.StringBuilder sb) Draws attribute to response output with it's value: attr=value.
static void	drawAttributes(Element element, java.lang.StringBuilder sb) Draws all annotated fields with Annotation of the Element.
static void	drawHTML(Element current, FireWebApplication app, java.lang.StringBuilder sb, boolean intro) Drawing HTML view below elements of this element in tree.
static java.lang.StringBuilder	drawView(FireWebApplication app) Redraw GUI view.
static java.lang.String	encodeScript(java.lang.String script, FireWebApplication app) 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.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.
static <T extends java.lang.annotation.Annotation> T	eventOptionFactory(java.lang.Class<T> optionType, java.lang.Object value) Factory provides event option instances with given value.
static Element	findElement(Element current, java.lang.String objectId) Finds web object in elements tree.
static EventListener	findEventListener(java.lang.Class<? extends java.lang.annotation.Annotation> eventType) Utility method which test if annotation is a EventListener.
static java.lang.annotation.Annotation	findOptionByType(java.util.Set<? extends java.lang.annotation.Annotation> options, java.lang.Class<? extends java.lang.annotation.Annotation> type) Utility method finding event option instance of it type.
static <T extends Element> T	findParent(java.lang.Class<T> c, Element curr) Looking in object tree parent object of given class type.
static java.lang.String	getApplicationAttributeName(java.lang.String servletName) Returns session attribute name
static java.util.Set<java.lang.annotation.Annotation>	getEventOptions(java.lang.Class<? extends java.lang.annotation.Annotation> eventType) Finds browser event options of annotation type.
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 ColorType	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.

Methods inherited from class java.lang.Object

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

Constructor Detail

Utils

public Utils()

Method Detail

drawHTML

public static final void drawHTML(Element current,
                                  FireWebApplication app,
                                  java.lang.StringBuilder sb,
                                  boolean intro)

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". if element type is null throws FireWebException.

Parameters:

current - Element to draw

app - Drawing context

sb - Drawing results buffer

intro - If draw intro of HTML code form Servlet false in other cases

drawView

public static final java.lang.StringBuilder drawView(FireWebApplication app)

Redraw GUI view. Write html into browser (client). After that on client, browser calls "onLoad" event of body element. Next engine past event "onLoad" back to server. If was call sendRedirest it break drawing process. This prevent to lost object changes between redirections. This prevent to lost object changes between redirections.

Parameters:

app - Drawing context

Returns:

HTML code of drew view.

drawAttribute

public static final void drawAttribute(java.lang.String attrName,
                                       java.lang.Object attrValue,
                                       boolean marker,
                                       java.lang.StringBuilder sb)

Draws attribute to response output with it's value: attr=value. If attrName is null or is null then attribute is not drawing.

Parameters:

attrName - Attribute name

attrValue - Attribute value. If is String type the value is surrounding by quotation - Constants.JS_QUOTATION_MARK. Attribute is escaped for HTML special and JS characters.

marker - If the attribute is type of marker

sb - Buffer for drawing result.

drawAttributes

public static final void drawAttributes(Element element,
                                        java.lang.StringBuilder sb)

Draws all annotated fields with Annotation of the Element.

Parameters:

element - to process

sb - buffer contains processing results

capitalizeFirstLetter

public static final java.lang.String capitalizeFirstLetter(java.lang.String original)

Utility method for generating getters name of annotated attributes.

Parameters:

original - name to capitalize

Returns:

capitalized name

findEventListener

public static final EventListener findEventListener(java.lang.Class<? extends java.lang.annotation.Annotation> eventType)

Utility method which test if annotation is a EventListener.

Parameters:

eventType - event type annotation

Returns:

found event listener or null

codeEventOptions

public static final int codeEventOptions(java.util.Set<java.lang.annotation.Annotation> options)

Computes browser event options value

Parameters:

options - event options set

Returns:

computed value

annotationOptionEquals

public static final boolean annotationOptionEquals(java.lang.annotation.Annotation a1,
                                                   java.lang.annotation.Annotation a2)

Event options comparator

Parameters:

a1 - Option to compare to a2

a2 - Option to compare to a1

Returns:

result of comparison

getEventOptions

public static final java.util.Set<java.lang.annotation.Annotation> getEventOptions(java.lang.Class<? extends java.lang.annotation.Annotation> eventType)

Finds browser event options of annotation type. List contains conjunction defaults Constants.BROWSER_EVENT_DEFAULTS and annotated values.

Parameters:

eventType - Event type annotation

Returns:

Browser event options set

findOptionByType

public static final java.lang.annotation.Annotation findOptionByType(java.util.Set<? extends java.lang.annotation.Annotation> options,
                                                                     java.lang.Class<? extends java.lang.annotation.Annotation> type)

Utility method finding event option instance of it type.

Parameters:

options - Set of event options

type - Option type

Returns:

found annotation instance or null if not found

eventOptionFactory

public static final <T extends java.lang.annotation.Annotation> T eventOptionFactory(java.lang.Class<T> optionType,
                                                                                     java.lang.Object value)

Factory provides event option instances with given value.

Type Parameters:

T - instance of optionType class

Parameters:

optionType - Event option type annotation

value - Event option value

Returns:

Event option instance

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

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,
                                                  FireWebApplication app)

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

app - context for charset

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

getApplicationAttributeName

public static final java.lang.String getApplicationAttributeName(java.lang.String servletName)

Returns session attribute name

Parameters:

servletName - Servlet name of the context

Returns:

The attribute name

findElement

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

Finds 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

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 ColorType 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.