org.fireweb

Class Element

java.lang.Object

org.fireweb.Element

Direct Known Subclasses:

Address, Anchor, Bdo, Blockquote, Button, DefinitionDescription, DefinitionList, DefinitionTerm, DeletedText, Div, Fieldset, FireWebApplication, Form, Heading, HorizontalRule, Image, Input, InsertedText, Label, Legend, LineBreak, ListItem, Option, OptionGroup, OrderedList, Paragraph, Select, Span, Table, TableCaption, TableCell, TableRow, TextArea, UnorderedList

public abstract class Element
extends java.lang.Object

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

Version:

3.3

Author:

Piotr Ptak

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	addListener(EventListener el) Add event to listen.
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 without event options.
Element	callBack(int duration, java.util.concurrent.TimeUnit unit, int options) Calls timer JavaScript to call back to the server.
Element	callScript(java.lang.String toCall) Adds script to caller buffer no matter if object view was drown.
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() without event processing options.
Element	confirm(java.lang.String text, int options) Calls JavaScript confirm().
protected Element	drawAttribute(java.lang.String attrName, java.lang.Object attrValue) Draws attribute to response output with it's value: attr=value.
<T extends Element> T	findElement(java.lang.String objectId) Finds element in application tree.
<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 EventListener> elc) Fires event if object is listening on and the event is not browser event.
Element	fireEvent(java.lang.Class<? extends EventListener> elc, Event we) Fires event if object is listening on and the event is not browser event.
Element	fireEventOnView(java.lang.Class<? extends EventListener> elc) 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 EventListener> elc, 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	getBundle(java.lang.String key) Find resource string in bundles defined by Constants.APPLICATION_RESOURCE_BUNDLE context parameter.
java.lang.Object	getBundleObject(java.lang.String key) Find resource object in bundles defined by Constants.APPLICATION_RESOURCE_BUNDLE context parameter.
java.lang.String	getCustomDragMove() Returns JavaScript function name or definition.
Direction.Type	getDir() Get text direction property
DragDropEventsOptions	getDragDropEventsOptions() Returns current & events options
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.
protected java.util.List<EventListener>	getEventListeners() Returns unmodifiable set of event listeners
java.lang.String	getId() Creates server object id which is: Constants.OBJECT_PREFIX + Integer.toHexString(super.hashCode()).
java.lang.String	getLang() Get lang property
<T extends Element> T	getParent() Return parent element.
CSS	getStyle()
java.lang.String	getStyleClass() Get list of style classes
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
Element	insert(int index, Element object) Insert's child element at given index.
protected boolean	isChildrenSetChanged() Test if children set changed
boolean	isContenteditable()
boolean	isDraggable()
boolean	isDrawn()
boolean	isEscapeText() Test if inner text is escaping for HTML tags.
boolean	isListening(java.lang.Class<? extends EventListener> elc) Test if object listening on event type.
boolean	isListening(EventListener instance) Test if object listening on event instance.
protected boolean	isListening(java.lang.String eln) Test if object listening on event name.
Element	print() Calls JavaScript print()
Element	prompt(java.lang.String title, java.lang.String value) Calls JavaScript prompt() without event processing options.
Element	prompt(java.lang.String title, java.lang.String value, int options) 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.
protected Element	removeAttribute(java.lang.String name) Calls removeAttribute Java Script on this element.
Element	removeDropTarget(Element dropTarget) Remove drop target element.
Element	removeListener(java.lang.Class<? extends EventListener> elc) Removes all event listeners form list of listeners with the class. if event implements CustomEventListener interface the disableEventUserJavaScript method is called.
Element	removeListener(EventListener el) Removes event listener instance form list of listeners. if event implements CustomEventListener interface the disableEventUserJavaScript method is called.
Element	removeParent() Detach the object from parent.
Element	removeStyleClass(java.lang.String tagClass) Removes style class from the list
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.
protected java.util.List<EventListener>	retrieveListeners(java.lang.Class<? extends EventListener> elc) Looking for event class in list of listeners.
protected java.util.List<EventListener>	retrieveListeners(java.lang.String eln) Looking for event name in list of listeners.
protected Element	setChangeChildrenSet(boolean changed) Set up if element state changed
Element	setContenteditable(boolean contenteditable)
Element	setCustomDragMove(java.lang.String customDragMove) Set JavaScript function definition or name ones.
Element	setDir(Direction.Type dir) Set text direction property
Element	setDragDropEventsOptions(DragDropEventsOptions dragDropEventsOptions) Set options for & events
Element	setDraggable(boolean draggable) On/Off Drag&Drop of this element.
protected Element	setDrawn(boolean drawn) Set if element drown.
Element	setEscapeText(boolean escapeText) Set if inner text is escaping.
Element	setLang(java.lang.String lang) Set lang property.
Element	setParent(Element parent) Set parent element of this object.
Element	setStyle(CSS tagStyle) Set inline style of the element.
Element	setStyleClass(java.lang.String tagClass) Set new style class.
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
protected java.lang.String	transformTagName(java.lang.String tagName) Transform tag name of this element defined by Type.tagName().

Methods inherited from class java.lang.Object

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

Constructor Detail

Element

public Element()

Method Detail

setChangeChildrenSet

protected Element setChangeChildrenSet(boolean changed)

Set up if element state changed

Parameters:

changed - the object to set the state

Returns:

this

isChildrenSetChanged

protected boolean isChildrenSetChanged()

Test if children set changed

Returns:

the childrenSetChanged

isListening

protected boolean isListening(java.lang.String eln)

Test if object listening on event name.

Parameters:

eln - Name of event.

Returns:

True if is listening false if not.

removeAttribute

protected Element removeAttribute(java.lang.String name)

Calls removeAttribute Java Script on this element.

Parameters:

name - Name of attribute to remove.

Returns:

this

getEventListeners

protected java.util.List<EventListener> getEventListeners()

Returns unmodifiable set of event listeners

Returns:

the event listeners

retrieveListeners

protected java.util.List<EventListener> retrieveListeners(java.lang.Class<? extends EventListener> elc)

Looking for event class in list of listeners.

Parameters:

elc - Class event listener to retrieve.

Returns:

null if not listening on or the listener if listening on.

retrieveListeners

protected java.util.List<EventListener> retrieveListeners(java.lang.String eln)

Looking for event name in list of listeners.

Parameters:

eln - Name of event.

Returns:

null if not listening on or the listener if listening on.

setDrawn

protected Element setDrawn(boolean drawn)

Set if element drown.

Parameters:

drawn - the drawn to set

Returns:

this

transformTagName

protected java.lang.String transformTagName(java.lang.String tagName)

Transform tag name of this element defined by Type.tagName(). Good example is h1,h2.. element - Heading .

Parameters:

tagName - value from annotation Type.tagName() .

Returns:

transformed tag name.

drawAttribute

protected Element drawAttribute(java.lang.String attrName,
                                java.lang.Object attrValue)

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.

Returns:

this

getId

public final java.lang.String getId()

Creates server object id which is: Constants.OBJECT_PREFIX + Integer.toHexString(super.hashCode()).

Returns:

server id of the object;

getApplication

public <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 <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 <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

findViewElements

public <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

findElement

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

Finds element in application tree. Shortcut to Utils.findElement

Type Parameters:

T - Class type

Parameters:

objectId - Object id to find

Returns:

this

clearElements

public Element clearElements()

Removes all children elements of this element.

Returns:

this

clearElements

public <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 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 Element remove(Element object)

Removes element form elements lying on this element.

Parameters:

object - the element to remove

Returns:

this

remove

public 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 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 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

callScript

public Element callScript(java.lang.String toCall)

Adds script to caller buffer no matter if object view was drown.

Parameters:

toCall - Java Script to call

Returns:

this

fireEvent

public Element fireEvent(java.lang.Class<? extends EventListener> elc,
                         Event we)

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

Parameters:

elc - Event class to fire.

we - Web object if is accessible or null.

Returns:

this

fireEvent

public Element fireEvent(java.lang.Class<? extends EventListener> elc)

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:

elc - Event class to fire.

Returns:

this

fireEventOnView

public Element fireEventOnView(java.lang.Class<? extends EventListener> elc,
                               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:

elc - Event class to fire.

we - Web object if is accessible or null.

Returns:

this

fireEventOnView

public Element fireEventOnView(java.lang.Class<? extends EventListener> elc)

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 fireEventOnView(Class, Event) with event object as null.

Parameters:

elc - Event class to fire.

Returns:

this

addListener

public Element addListener(EventListener el)

Add event to listen. Listener is added if not exists on listener's list.

Parameters:

el - Event listener object to add.

Returns:

this

isListening

public boolean isListening(java.lang.Class<? extends EventListener> elc)

Test if object listening on event type.

Parameters:

elc - Class event listener to test

Returns:

true if is listening.

isListening

public boolean isListening(EventListener instance)

Test if object listening on event instance.

Parameters:

instance - Event listener instance

Returns:

true if is listening

removeListener

public Element removeListener(java.lang.Class<? extends EventListener> elc)

Removes all event listeners form list of listeners with the class. if event implements CustomEventListener interface the disableEventUserJavaScript method is called.

Parameters:

elc - Class event listener to remove.

Returns:

this

removeListener

public Element removeListener(EventListener el)

Removes event listener instance form list of listeners. if event implements CustomEventListener interface the disableEventUserJavaScript method is called.

Parameters:

el - Event listeners instance to remove

Returns:

this

isDraggable

public boolean isDraggable()

Returns:

if element is draggable

setDraggable

public Element setDraggable(boolean draggable)

On/Off Drag&Drop of this element.

Parameters:

draggable - true/false

Returns:

this

getDropTargets

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

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

Returns:

Set of elements

addDropTarget

public 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 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 Element clearDropTargets()

Remove all drop target element.

Returns:

this object

addAllDropTargets

public 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

getCustomDragMove

public java.lang.String getCustomDragMove()

Returns JavaScript function name or definition.

Returns:

String contains function name or ones definition

setCustomDragMove

public Element setCustomDragMove(java.lang.String customDragMove)

Set JavaScript function definition or name ones. The function must return content of movement container after element dragging. Default is:

 this.customDragMove = function(toMove) {
                return toMove.cloneNode(true);
 };
 

Parameters:

customDragMove - JavaScript function name or body

Returns:

this element

getDragDropEventsOptions

public DragDropEventsOptions getDragDropEventsOptions()

Returns current & events options

Returns:

the & options for events

setDragDropEventsOptions

public Element setDragDropEventsOptions(DragDropEventsOptions dragDropEventsOptions)

Set options for & events

Parameters:

dragDropEventsOptions - the options setup

Returns:

this

alert

public Element alert(java.lang.String text)

Calls JavaScript alert()

Parameters:

text - the text to display

Returns:

this

print

public Element print()

Calls JavaScript print()

Returns:

this

confirm

public Element confirm(java.lang.String text,
                       int options)

Calls JavaScript confirm().

Parameters:

text - the text to display

options - of event processing. Allowed: Constants.OPTION_FEEDBACK and Constants.OPTION_BEFOREAFTER, eg. Constants.OPTION_FEEDBACK | Constants.OPTION_BEFOREAFTER

Returns:

this

confirm

public Element confirm(java.lang.String text)

Calls JavaScript confirm() without event processing options. To processing the call back add event listener of OnConfirm.

Parameters:

text - the text to display

Returns:

this

prompt

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

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

Parameters:

title - title to display

value - default value

options - of event processing. Allowed: Constants.OPTION_FEEDBACK and Constants.OPTION_BEFOREAFTER, eg. Constants.OPTION_FEEDBACK | Constants.OPTION_BEFOREAFTER

Returns:

this

prompt

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

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

Parameters:

title - title to display

value - default value

Returns:

this

callBack

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

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

options - of event processing. Allowed: Constants.OPTION_FEEDBACK and Constants.OPTION_BEFOREAFTER, eg. Constants.OPTION_FEEDBACK | Constants.OPTION_BEFOREAFTER

Returns:

this

callBack

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

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

Parameters:

duration - of timeout

unit - of time duration

Returns:

this

getStyleClass

public java.lang.String getStyleClass()

Get list of style classes

Returns:

the styleClass

setStyleClass

public Element setStyleClass(java.lang.String tagClass)

Set new style class.

Parameters:

tagClass - the tagClass to set

Returns:

this

addStyleClass

public Element addStyleClass(java.lang.String tagClass)

Add style class to list.

Parameters:

tagClass - CSS class name

Returns:

this

removeStyleClass

public Element removeStyleClass(java.lang.String tagClass)

Removes style class from the list

Parameters:

tagClass - CSS class name

Returns:

this

replaceStyleClass

public 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 CSS getStyle()

Returns:

the inline style of element

setStyle

public Element setStyle(CSS tagStyle)

Set inline style of the element.

Parameters:

tagStyle - the style to set

Returns:

this

getTitle

public java.lang.String getTitle()

Get title property of the element

Returns:

the title

setTitle

public Element setTitle(java.lang.String tagTitle)

Set title property of the element

Parameters:

tagTitle - the title to set

Returns:

this

getText

public java.lang.String getText()

Get text of the element

Returns:

the innerHTML text of the element

setText

public 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 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 Direction.Type getDir()

Get text direction property

Returns:

the dir property

setDir

public Element setDir(Direction.Type dir)

Set text direction property

Parameters:

dir - the dir property to set

Returns:

this

getLang

public java.lang.String getLang()

Get lang property

Returns:

the lang property

setLang

public Element setLang(java.lang.String lang)

Set lang property.

Parameters:

lang - the lang to set.

Returns:

this

getTabIndex

public java.lang.Integer getTabIndex()

Specifies the tab order of an element.

Returns:

the tabIndex

setTabIndex

public 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 Element focus()

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

Returns:

this

isEscapeText

public boolean isEscapeText()

Test if inner text is escaping for HTML tags. Default is true.

Returns:

the escapeText

setEscapeText

public Element setEscapeText(boolean escapeText)

Set if inner text is escaping.

Parameters:

escapeText - the escapeText to set

Returns:

this

isDrawn

public boolean isDrawn()

Returns:

the drawn

getBundle

public java.lang.String getBundle(java.lang.String key)

Find resource string in bundles defined by Constants.APPLICATION_RESOURCE_BUNDLE context parameter.

Parameters:

key - resource bundle string to find

Returns:

found resource string

Throws:

java.util.MissingResourceException - if not found resource by the key

getBundleObject

public java.lang.Object getBundleObject(java.lang.String key)

Find resource object in bundles defined by Constants.APPLICATION_RESOURCE_BUNDLE context parameter.

Parameters:

key - resource bundle string to find

Returns:

found resource object

Throws:

java.util.MissingResourceException - if not found resource by the key

isContenteditable

public boolean isContenteditable()

Returns:

the content editable

setContenteditable

public Element setContenteditable(boolean contenteditable)

Parameters:

contenteditable - the contenteditable to set

Returns:

this

firePropertyChange

public 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