org.fireweb

Class Element

java.lang.Object

org.fireweb.Element

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

Address, Anchor, Bdo, Blockquote, Button, DefinitionDescription, DefinitionList, DefinitionTerm, DeletedText, Div, EventsListener, Fieldset, FireWebApplication, Form, Heading1, Heading2, Heading3, Heading4, Heading5, Heading6, HorizontalRule, Image, Input, InsertedText, Label, Legend, LineBreak, ListItem, Option, OptionGroup, OrderedList, Paragraph, Select, SomethnigWithAttributes, Span, Table, TableCaption, TableCell, TableRow, TextArea, UnorderedList

public abstract class Element
extends java.lang.Object
implements java.io.Serializable

Main class of all dynamic object which renders HTML view's, JavaScript and events receivers.

Version:

4.0

Author:

Piotr Ptak

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Element()

Method Summary

Modifier and Type	Method and Description
Element	add(Element object) Adds element to end of list of element lying on this element.
Element	addAllDropTargets(java.util.Collection<Element> drops) Add collection of drop target elements.
Element	addDropTarget(Element dropTarget) Add drop target element.
Element	addStyleClass(java.lang.String tagClass) Add style class to list.
Element	alert(java.lang.String text) Calls JavaScript alert()
Element	assignText(java.lang.String text) Set text body value without changing object state and without sending JavaScript to browser.
Element	callBack(int duration, java.util.concurrent.TimeUnit unit) Calls timer JavaScript to call back to the server.
Element	callScript(java.lang.String script) Send script to browser or add to buffer if WebCocket is not available.
Element	clearDropTargets() Remove all drop target element.
Element	clearElements() Removes all children elements of this element.
<T extends Element> Element	clearElements(java.lang.Class<T> c) Removes all children elements of this element.
Element	confirm(java.lang.String text) Calls JavaScript confirm().
<T extends Element> T	findElement(java.lang.String objectId) Finds element in application tree.
java.util.Set<java.lang.annotation.Annotation>	findEventOptions(java.lang.Class<? extends java.lang.annotation.Annotation> eventType) Retrieves event options taking into account class hierarchy and dynamic options defined at runtime.
<T extends Element> T	findParent(java.lang.Class<T> c) Looking for first occurrence parent element in tree with given class type.
<T extends Element> java.util.List<T>	findViewElements(java.lang.Class<T> c) Returns unmodifiable children list of element selected by any class type of objects lying on element and elements in tree view where parent is this element.
Element	fireEvent(java.lang.Class<? extends java.lang.annotation.Annotation> eventType) Fires event if object is listening on and the event is not browser event.
Element	fireEvent(java.lang.Class<? extends java.lang.annotation.Annotation> eventType, Event we) Fires event if object is listening on and the event is not browser event.
Element	fireEventOnView(java.lang.Class<? extends java.lang.annotation.Annotation> eventType) Fires event on all objects in the view if objects are listening on and the event is not browser event.
Element	fireEventOnView(java.lang.Class<? extends java.lang.annotation.Annotation> eventType, Event we) Fires event on all objects in view if objects are listening on and the event is not browser event.
Element	firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue) Shortcut to PropertyChangeSupport method.
Element	focus() The focus() method is used to give focus to a input or element with tabIndex >= 0.
<T extends FireWebApplication> T	getApplication() Obtain the application object from objects tree.
java.lang.String	getContenteditableValue()
Direction.Type	getDir() Get text direction property
java.util.Set<Element>	getDropTargets() Unmodifiable set of drop targets for this element of Drag&Drop.
java.util.List<Element>	getElements() Returns unmodifiable children list of this element
<T extends Element> java.util.List<T>	getElements(java.lang.Class<T> c) Returns unmodifiable children list of this element selected by Element subclass type and lying on this element.
java.util.List<java.lang.reflect.Method>	getEventListeners(java.lang.Class<? extends java.lang.annotation.Annotation> eventType) Retrieve event's listeners.
java.lang.String	getId() Creates server object id (HEX), based on Object.hashCode().
java.lang.String	getLang() Get lang property
<T extends Element> T	getParent() Return parent element.
java.lang.String	getStyle() Returns text representation of inline styles of the element.
<T extends StyleElement> T	getStyle(java.lang.Class<T> styleType) Finds inline style of this element.
java.lang.String	getStyleClass() Get list of style classes
java.util.Collection<StyleElement>	getStyles() Returns collection of inline styles of the element.
java.lang.Integer	getTabIndex() Specifies the tab order of an element.
java.lang.String	getText() Get text of the element
java.lang.String	getTitle() Get title property of the element
java.util.Set<java.lang.Class<? extends java.lang.annotation.Annotation>>	getTypeEvents() Returns set of all event listeners of this class
Element	insert(int index, Element object) Insert's child element at given index.
boolean	isChildrenSetChanged() Test if children set changed
boolean	isContenteditable()
boolean	isDraggable() Test if is on the class any listener of OnDrag event.
boolean	isDrawn()
boolean	isListening(java.lang.Class<? extends java.lang.annotation.Annotation> eventType) Test if object listening on event type.
Element	listenerOff(java.lang.Class<? extends java.lang.annotation.Annotation> eventType) Mark event listener as disabled and draws JavaScript to browser.
Element	listenerOn(java.lang.Class<? extends java.lang.annotation.Annotation> eventType) Remove tag event listener as disabled and draws JavaScript to browser.
Element	print() Calls JavaScript print()
Element	prompt(java.lang.String title, java.lang.String value) Calls JavaScript prompt().
Element	remove(Element object) Removes element form elements lying on this element.
Element	remove(int index) Removes element at index form elements lying on this element.
Element	removeDropTarget(Element dropTarget) Remove drop target element.
Element	removeEventOptions(java.lang.Class<? extends java.lang.annotation.Annotation> eventType, java.lang.Class<? extends java.lang.annotation.Annotation>... eventOptionType) Removes event options.
Element	removeParent() Detach the object from parent.
Element	removeStyle(java.lang.Class<? extends StyleElement> styleType) Removes inline style of the element.
Element	removeStyleClass(java.lang.String tagClass) Removes style class from the list
Element	removeStyles() Clears inline styles of the element
Element	replace(int index, Element object) Replace child element at given index.
Element	replaceStyleClass(java.lang.String fromClass, java.lang.String toClass) Replace style class from regex pattern to new one.
Element	setChangeChildrenSet(boolean changed) Set up if element state changed
Element	setContenteditable(boolean contenteditable)
Element	setDir(Direction.Type dir) Set text direction property
Element	setDrawn(boolean drawn) Set if element drown.
Element	setEventOptions(java.lang.Class<? extends java.lang.annotation.Annotation> eventType, java.lang.annotation.Annotation... newValues) Override event options.
Element	setLang(java.lang.String lang) Set lang property.
Element	setParent(Element parent) Set parent element of this object.
Element	setStyle(StyleElement styleElement) Add inline style to the element.
Element	setStyleClass(java.lang.String tagClass) Set new style class.
Element	setStyles(java.util.Set<StyleElement> styles) Replaces inline styles of the element.
Element	setTabIndex(java.lang.Integer tabIndex) Set "tabindex" property and if element drew call script at browser.
Element	setText(java.lang.String text) Set text body value and changing object state.
Element	setTitle(java.lang.String tagTitle) Set title property of the element

Methods inherited from class java.lang.Object

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

Constructor Detail

Element

public Element()

Method Detail

getId

public final java.lang.String getId()

Creates server object id (HEX), based on Object.hashCode().

Returns:

server id of the object;

getApplication

public final <T extends FireWebApplication> T getApplication()

Obtain the application object from objects tree.

Type Parameters:

T - type of application

Returns:

the application object

getParent

public final <T extends Element> T getParent()

Return parent element.

Type Parameters:

T - type of element

Returns:

the this type of parent element

findParent

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

Looking for first occurrence parent element in tree with given class type.

Type Parameters:

T - type of element

Parameters:

c - Class of searched element type

Returns:

the this type of parent element

setParent

public final Element setParent(Element parent)

Set parent element of this object. If parent is null then assign form parameter otherwise if current parent object is not equals that from parameter then overwrites current parent object by that one from parameter.

Parameters:

parent - The parent container

Returns:

this

removeParent

public final Element removeParent()

Detach the object from parent.

Returns:

this

getElements

public final java.util.List<Element> getElements()

Returns unmodifiable children list of this element

Returns:

the elements

getElements

public final <T extends Element> java.util.List<T> getElements(java.lang.Class<T> c)

Returns unmodifiable children list of this element selected by Element subclass type and lying on this element.

Type Parameters:

T - Class type

Parameters:

c - Element class type to search

Returns:

the list elements of given class type T

setChangeChildrenSet

public final Element setChangeChildrenSet(boolean changed)

Set up if element state changed

Parameters:

changed - the object to set the state

Returns:

this

isChildrenSetChanged

public final boolean isChildrenSetChanged()

Test if children set changed

Returns:

the childrenSetChanged

setDrawn

public final Element setDrawn(boolean drawn)

Set if element drown.

Parameters:

drawn - the drawn to set

Returns:

this

findViewElements

public final <T extends Element> java.util.List<T> findViewElements(java.lang.Class<T> c)

Returns unmodifiable children list of element selected by any class type of objects lying on element and elements in tree view where parent is this element.

Type Parameters:

T - Class type

Parameters:

c - Any class or interface.

Returns:

the list of Element objects implement of class T

callScript

public final Element callScript(java.lang.String script)

Send script to browser or add to buffer if WebCocket is not available.

Parameters:

script - Java Script to call

Returns:

this

findElement

public final <T extends Element> T findElement(java.lang.String objectId)

Finds element in application tree. Shortcut to Utils.findElement(Element, String)

Type Parameters:

T - Class type

Parameters:

objectId - Object id to find

Returns:

this

clearElements

public final Element clearElements()

Removes all children elements of this element.

Returns:

this

clearElements

public final <T extends Element> Element clearElements(java.lang.Class<T> c)

Removes all children elements of this element.

Type Parameters:

T - Class type

Parameters:

c - Element type class to remove

Returns:

this

add

public final Element add(Element object)

Adds element to end of list of element lying on this element.

Parameters:

object - the element to add

Returns:

this

remove

public final Element remove(Element object)

Removes element form elements lying on this element.

Parameters:

object - the element to remove

Returns:

this

remove

public final Element remove(int index)

Removes element at index form elements lying on this element.

Parameters:

index - of the element to remove.

Returns:

this

insert

public final Element insert(int index,
                            Element object)

Insert's child element at given index. If parent is null or current parent object is not equals then assign this object as parent.

Parameters:

index - Where to place the element at this container

object - The web object to insert.

Returns:

this

replace

public final Element replace(int index,
                             Element object)

Replace child element at given index. If parent is null then assign form parameter otherwise if current parent object is not equals that from parameter then overwrites current parent object.

Parameters:

index - Where to place the element at this container

object - The web object to set.

Returns:

this

fireEvent

public final Element fireEvent(java.lang.Class<? extends java.lang.annotation.Annotation> eventType,
                               Event we)

Fires event if object is listening on and the event is not browser event.

Parameters:

eventType - Event annotation to fire.

we - Web object if is accessible or null.

Returns:

this

fireEvent

public final Element fireEvent(java.lang.Class<? extends java.lang.annotation.Annotation> eventType)

Fires event if object is listening on and the event is not browser event. Shortcut to fireEvent(Class, Event) with event object as null.

Parameters:

eventType - Event annotation to fire.

Returns:

this

fireEventOnView

public final Element fireEventOnView(java.lang.Class<? extends java.lang.annotation.Annotation> eventType,
                                     Event we)

Fires event on all objects in view if objects are listening on and the event is not browser event. The root of action in this object. Event is fire up in natural order of elements in view.

Parameters:

eventType - Event class to fire.

we - Web object if is accessible or null.

Returns:

this

fireEventOnView

public final Element fireEventOnView(java.lang.Class<? extends java.lang.annotation.Annotation> eventType)

Fires event on all objects in the view if objects are listening on and the event is not browser event. The root of action in this object. Event is fire up in natural order of elements in view. Shortcut to fireEvent(Class, Event) with event object as null.

Parameters:

eventType - Event class to fire.

Returns:

this

getTypeEvents

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

Returns set of all event listeners of this class

Returns:

the event listeners set

getEventListeners

public final java.util.List<java.lang.reflect.Method> getEventListeners(java.lang.Class<? extends java.lang.annotation.Annotation> eventType)

Retrieve event's listeners. The listeners are annotated class method. The event listener must be turn on.

Parameters:

eventType - Event listener annotation.

Returns:

List of listeners. The result list is empty for turn off listeners.

isListening

public final boolean isListening(java.lang.Class<? extends java.lang.annotation.Annotation> eventType)

Test if object listening on event type.

Parameters:

eventType - Class event listener to test

Returns:

true if is listening.

setEventOptions

public final Element setEventOptions(java.lang.Class<? extends java.lang.annotation.Annotation> eventType,
                                     java.lang.annotation.Annotation... newValues)

Override event options. At runtime sends to browser new event listener with modified options. If annotation is not a EventListener then throws FireWebException.

Parameters:

eventType - event type

newValues - new values of event option

Returns:

this

removeEventOptions

public final Element removeEventOptions(java.lang.Class<? extends java.lang.annotation.Annotation> eventType,
                                        java.lang.Class<? extends java.lang.annotation.Annotation>... eventOptionType)

Removes event options. At runtime sends to browser new event listener with modified options. If annotation is not a EventListener then throws FireWebException.

Parameters:

eventType - event type

eventOptionType - List of event's option to remove

Returns:

this

findEventOptions

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

Retrieves event options taking into account class hierarchy and dynamic options defined at runtime.

Parameters:

eventType - event type class

Returns:

real browser event options set.

listenerOn

public final Element listenerOn(java.lang.Class<? extends java.lang.annotation.Annotation> eventType)

Remove tag event listener as disabled and draws JavaScript to browser. If there are any CustomizedListeners then the CustomizedListener.enableEvent(Element, Class) is called of it. If there are not listeners of event then the FireWebException exception will be thrown.

Parameters:

eventType - Event type to of listening.

Returns:

this

listenerOff

public final Element listenerOff(java.lang.Class<? extends java.lang.annotation.Annotation> eventType)

Mark event listener as disabled and draws JavaScript to browser. If there are any CustomizedListeners then the CustomizedListener.enableEvent(Element, Class) is called of it. If there are not listeners or the listener is not a browser event then the FireWebException exception will be thrown.

Parameters:

eventType - Event type to of listening.

Returns:

this

isDraggable

public final boolean isDraggable()

Test if is on the class any listener of OnDrag event.

Returns:

if element is draggable

getDropTargets

public final java.util.Set<Element> getDropTargets()

Unmodifiable set of drop targets for this element of Drag&Drop.

Returns:

Set of elements

addDropTarget

public final Element addDropTarget(Element dropTarget)

Add drop target element.

Parameters:

dropTarget - Other element which will receive onDrop event comes from this element.

Returns:

this

removeDropTarget

public final Element removeDropTarget(Element dropTarget)

Remove drop target element.

Parameters:

dropTarget - Other element which will receive onDrop event comes from this element.

Returns:

this

clearDropTargets

public final Element clearDropTargets()

Remove all drop target element.

Returns:

this object

addAllDropTargets

public final Element addAllDropTargets(java.util.Collection<Element> drops)

Add collection of drop target elements.

Parameters:

drops - Other element which will receive onDrop event comes from this element.

Returns:

this

alert

public final Element alert(java.lang.String text)

Calls JavaScript alert()

Parameters:

text - the text to display

Returns:

this

print

public final Element print()

Calls JavaScript print()

Returns:

this

confirm

public final Element confirm(java.lang.String text)

Calls JavaScript confirm().

Parameters:

text - the text to display

Returns:

this

prompt

public final Element prompt(java.lang.String title,
                            java.lang.String value)

Calls JavaScript prompt(). To processing the call back add event listener of OnPrompt.

Parameters:

title - title to display

value - default value

Returns:

this

callBack

public final Element callBack(int duration,
                              java.util.concurrent.TimeUnit unit)

Calls timer JavaScript to call back to the server. To processing the call back add event listener of OnCallBack.

Parameters:

duration - of timeout

unit - of time duration

Returns:

this

getStyleClass

public final java.lang.String getStyleClass()

Get list of style classes

Returns:

the styleClass

setStyleClass

public final Element setStyleClass(java.lang.String tagClass)

Set new style class.

Parameters:

tagClass - the tagClass to set

Returns:

this

addStyleClass

public final Element addStyleClass(java.lang.String tagClass)

Add style class to list.

Parameters:

tagClass - CSS class name

Returns:

this

removeStyleClass

public final Element removeStyleClass(java.lang.String tagClass)

Removes style class from the list

Parameters:

tagClass - CSS class name

Returns:

this

replaceStyleClass

public final Element replaceStyleClass(java.lang.String fromClass,
                                       java.lang.String toClass)

Replace style class from regex pattern to new one. If style did not exists in elements class list then add it to the list.

Parameters:

fromClass - regex expression of CSS class name to replace

toClass - new CSS class name

Returns:

this object

getStyle

public final java.lang.String getStyle()

Returns text representation of inline styles of the element.

Returns:

the inline style string

getStyle

public final <T extends StyleElement> T getStyle(java.lang.Class<T> styleType)

Finds inline style of this element.

Type Parameters:

T - type of return style

Parameters:

styleType - Type of inline style

Returns:

Style element or null if not found

setStyle

public final Element setStyle(StyleElement styleElement)

Add inline style to the element. If exists it is overwriting.

Parameters:

styleElement - Inline style element to set

Returns:

this

removeStyle

public final Element removeStyle(java.lang.Class<? extends StyleElement> styleType)

Removes inline style of the element.

Parameters:

styleType - Type of inline style

Returns:

this

getStyles

public final java.util.Collection<StyleElement> getStyles()

Returns collection of inline styles of the element.

Returns:

Unmodifiable collection.

removeStyles

public final Element removeStyles()

Clears inline styles of the element

Returns:

this

setStyles

public final Element setStyles(java.util.Set<StyleElement> styles)

Replaces inline styles of the element.

Parameters:

styles - set of styles

Returns:

this

getTitle

public final java.lang.String getTitle()

Get title property of the element

Returns:

the title

setTitle

public final Element setTitle(java.lang.String tagTitle)

Set title property of the element

Parameters:

tagTitle - the title to set

Returns:

this

getText

public final java.lang.String getText()

Get text of the element

Returns:

the innerHTML text of the element

setText

public final Element setText(java.lang.String text)

Set text body value and changing object state. You must not to add text to tag has no close elementType. You must not to add text to tag has no close tag of no inner HTML container.

Parameters:

text - the text to set

Returns:

this

assignText

public final Element assignText(java.lang.String text)

Set text body value without changing object state and without sending JavaScript to browser. You must not to add text to tag has no close tag of no inner HTML container.

Parameters:

text - the text to set

Returns:

this

getDir

public final Direction.Type getDir()

Get text direction property

Returns:

the dir property

setDir

public final Element setDir(Direction.Type dir)

Set text direction property

Parameters:

dir - the dir property to set

Returns:

this

getLang

public final java.lang.String getLang()

Get lang property

Returns:

the lang property

setLang

public final Element setLang(java.lang.String lang)

Set lang property.

Parameters:

lang - the lang to set.

Returns:

this

getTabIndex

public final java.lang.Integer getTabIndex()

Specifies the tab order of an element.

Returns:

the tabIndex

setTabIndex

public final Element setTabIndex(java.lang.Integer tabIndex)

Set "tabindex" property and if element drew call script at browser.

Parameters:

tabIndex - the tabIndex to set. If is null or less then 0 calls set empty value to element at browser. If not null calls assign value to element at browser.

Returns:

this

focus

public final Element focus()

The focus() method is used to give focus to a input or element with tabIndex >= 0.

Returns:

this

isDrawn

public final boolean isDrawn()

Returns:

the drawn

isContenteditable

public final boolean isContenteditable()

Returns:

the content editable

getContenteditableValue

public final java.lang.String getContenteditableValue()

Returns:

the content editable string for attribute drawing

setContenteditable

public final Element setContenteditable(boolean contenteditable)

Parameters:

contenteditable - the contenteditable to set

Returns:

this

firePropertyChange

public final Element firePropertyChange(java.lang.String propertyName,
                                        java.lang.Object oldValue,
                                        java.lang.Object newValue)

Shortcut to PropertyChangeSupport method.

Parameters:

propertyName - of the element

oldValue - of the property

newValue - of the property

Returns:

this element