com.sencha.gxt.core.client.dom

Class CompositeElement

java.lang.Object

com.sencha.gxt.core.client.dom.CompositeElement

public class CompositeElement
extends Object

Wraps an list of elements, allowing code to be applied to each element using a CompositeFunction.

Constructor Summary

Constructors

Constructor and Description
CompositeElement() Creates a new composite element.
CompositeElement(Element[] elements) Creates a new composite element.
CompositeElement(List<Element> elements) Creates a new composite element.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Element elem) Adds an element.
void	add(Elements elements) Adds the elements.
void	addClassName(String cls) Removes the class name.
boolean	contains(Element elem) Returns true if this composite contains the passed element.
void	each(CompositeFunction f) Calls the passed function passing (el, this, index) for each element in this composite.
Element	first() Returns the first element.
int	getCount() Returns the number of elements in this composite.
Element	getElement(int index) Returns the element at the given index.
List<Element>	getElements() The list of elements.
int	indexOf(Element elem) Returns the index of the given element.
void	insert(Element[] elems, int index) Inserts the elements at the given index.
void	insert(Element elem, int index) Inserts an element at the given index.
boolean	is(Element elem) Returns true if the given element is or is a child of any contained element.
Element	item(int index) Returns the Element object at the specified index.
Element	last() Returns the last element.
void	remove(Element element) Removes an element.
void	remove(int index) Removes an element.
void	removeAll() Removes all elements.
void	removeClassName(String cls) Removes the class name.
boolean	replaceElement(Element elem, Element replace) Replaces an element.
void	setHeight(int height) Sets the element's height.
void	setInnerHtml(String html) Sets the element's inner HTML.
void	setWidth(int width) Sets the element's width.
void	setWidth(String width) Sets the element's width.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeElement

public CompositeElement()

Creates a new composite element.

CompositeElement

public CompositeElement(Element[] elements)

Creates a new composite element.

Parameters:

elements - the initial elements

CompositeElement

public CompositeElement(List<Element> elements)

Creates a new composite element.

Parameters:

elements - the initial elements

Method Detail

add

public void add(Element elem)

Adds an element.

Parameters:

elem - the element to add

add

public void add(Elements elements)

Adds the elements.

Parameters:

elements - the elements to add

addClassName

public void addClassName(String cls)

Removes the class name.

Parameters:

cls - the class name

contains

public boolean contains(Element elem)

Returns true if this composite contains the passed element.

Parameters:

elem - the element

Returns:

the contains state

each

public void each(CompositeFunction f)

Calls the passed function passing (el, this, index) for each element in this composite.

Parameters:

f - the function

first

public Element first()

Returns the first element.

Returns:

the element

getCount

public int getCount()

Returns the number of elements in this composite.

Returns:

the count

getElement

public Element getElement(int index)

Returns the element at the given index.

Parameters:

index - the element index

Returns:

the element

getElements

public List<Element> getElements()

The list of elements.

indexOf

public int indexOf(Element elem)

Returns the index of the given element.

Parameters:

elem - the element

Returns:

the index

insert

public void insert(Element elem,
          int index)

Inserts an element at the given index.

Parameters:

elem - the element to add

index - the insert location

insert

public void insert(Element[] elems,
          int index)

Inserts the elements at the given index.

Parameters:

elems - the elements to insert

index - the insert location

is

public boolean is(Element elem)

Returns true if the given element is or is a child of any contained element.

Parameters:

elem - the element to test

Returns:

the is state

item

public Element item(int index)

Returns the Element object at the specified index.

Parameters:

index - the index

Returns:

the element

last

public Element last()

Returns the last element.

Returns:

the last element

remove

public void remove(Element element)

Removes an element.

Parameters:

element - the element to remove

remove

public void remove(int index)

Removes an element.

Parameters:

index - the index of the element to remove

removeAll

public void removeAll()

Removes all elements.

removeClassName

public void removeClassName(String cls)

Removes the class name.

Parameters:

cls - the class name

replaceElement

public boolean replaceElement(Element elem,
                     Element replace)

Replaces an element.

Parameters:

elem - the element to remove

replace - the element to replace

Returns:

true if the item was replaced

setHeight

public void setHeight(int height)

Sets the element's height.

Parameters:

height - the height

setInnerHtml

public void setInnerHtml(String html)

Sets the element's inner HTML.

Parameters:

html - the html

setWidth

public void setWidth(int width)

Sets the element's width.

Parameters:

width - the width

setWidth

public void setWidth(String width)

Sets the element's width.

Parameters:

width - the width