com.groiss.gui

Class AbstractComponent

java.lang.Object

com.groiss.gui.AbstractComponent

All Implemented Interfaces:

Component, Serializable, Cloneable

Direct Known Subclasses:

AbstractContainer, Checkbox, ComparableComponent, FileChooser, Image, Link, RadioButton, RadioGroup, SelectList, SubmitButton, Text, Textarea, Textfield

public abstract class AbstractComponent
extends Object
implements Component

abstract implementation of the component interface with some common code for subclasses

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static short	ACTIVE some view modes
protected short	browserMode for which browser should the component be rendered
static short	DEFAULT some browser modes
static String	ID the id of attribute of a component
static short	IE
static short	INVISIBLE
protected boolean	isSensitive shows if the component can listen to events
protected Label	label the reference to the component, which is the label of this component
static short	NS
static String	ON_BLUR
static String	ON_CHANGE some defined events specially for select lists
static String	ON_CLICK some defined common events
static String	ON_DBLCLICK
static String	ON_FOCUS some defined events for components that can get the focus
static String	ON_KEY_DOWN
static String	ON_KEY_PRESS
static String	ON_KEY_UP
static String	ON_LOAD some defined events specially for the htmlpage
static String	ON_MOUSE_DOWN
static String	ON_MOUSE_MOVE
static String	ON_MOUSE_OUT
static String	ON_MOUSE_UP
static String	ON_RESET
static String	ON_SELECT some defined events specially for textareas and inputfields
static String	ON_SUBMIT some defined events specially for the formcontainer
static String	ON_UNLOAD
protected Container	parent
protected Element	parentElem the parent element of the components root
static short	READONLY
protected Element	root the root element of the internal JDOM-Tree of the component
protected short	viewMode how should the component be rendered

Fields inherited from interface com.groiss.gui.Component

LABELLEDBY

Constructor Summary

Constructors

Constructor and Description
AbstractComponent()
AbstractComponent(Element root) constructs a new component from an existing JDOM the root element must have an id attribute
AbstractComponent(String name)
AbstractComponent(String name, String id, String className) constructs a new empty component and creates an internal JDOM that consists of an empty root element

Method Summary

Modifier and Type	Method and Description
Component	addClass(String clazz) add the given CSS class(es) to the list of existing CSS-classes
Object	clone() returns a copy of the Component object
static Component	create(Element root) Create element from dom
String	getAttribute(String name) returs the value of an attribute
short	getBrowserMode()
Object	getContent()
String	getId()
Label	getLabel()
String	getName()
Container	getParent()
Element	getParentElement()
Element	getRoot() returns the root element of the internal JDOM
String	getRootName()
String	getStyle()
short	getViewMode()
void	init(Element element) Initialize the component with a jdom-tree.
void	init(String name)
void	init(String name, String id, String className) initialize the component with an new jdom-tree
boolean	removeAttribute(String name) Remove the attribute from the component.
Component	removeClass(String clazz) remove the given CSS class(es) from the list of existing CSS-classes
void	setActionListener(String event, String action) Sets the action to an event.
Component	setAttribute(String name, String value) sets the attribute to the component
void	setBrowserMode(short mode) sets the browserMode
Component	setClass(String clazz) set the CSS-class attribute to the given value
void	setContent(Object o) sets the content of the component
void	setEncoding(boolean val) Deprecated. method does nothing
void	setExpandEmptyElements(boolean val) Deprecated. method does nothing
void	setId(String id) set the unique identifier to a given value.
void	setIndenting(boolean val) Deprecated. method does nothing
void	setLabel(Label c) sets the label component
void	setName(String name) set the name to a given value.
void	setNewLines(boolean val) Deprecated. method does nothing
void	setParent(Container parent) sets the parent container
void	setParentElement(Element parent) sets the parent element of the components root
void	setRootName(String name) set the name of the root element to a given value.
void	setStyle(String style) Set the style
void	setViewMode(short mode) sets the viewMode
String	show() method for rendering the component as string
void	show(PrintWriter pw) prints the rendered component to a PrintWriter
Component	toggleClass(String clazz, boolean add) remove or add the given CSS class(es) from the list of existing CSS-classes depending on a condition
String	toString() Returns the classname followed by a colon and the title attribute.

Methods inherited from class java.lang.Object

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

Field Detail

ACTIVE

public static final short ACTIVE

some view modes

See Also:

Constant Field Values

READONLY

public static final short READONLY

See Also:

Constant Field Values

INVISIBLE

public static final short INVISIBLE

See Also:

Constant Field Values

DEFAULT

public static final short DEFAULT

some browser modes

See Also:

Constant Field Values

NS

public static final short NS

See Also:

Constant Field Values

IE

public static final short IE

See Also:

Constant Field Values

ON_CLICK

public static final String ON_CLICK

some defined common events

See Also:

Constant Field Values

ON_DBLCLICK

public static final String ON_DBLCLICK

See Also:

Constant Field Values

ON_MOUSE_DOWN

public static final String ON_MOUSE_DOWN

See Also:

Constant Field Values

ON_MOUSE_UP

public static final String ON_MOUSE_UP

See Also:

Constant Field Values

ON_MOUSE_MOVE

public static final String ON_MOUSE_MOVE

See Also:

Constant Field Values

ON_MOUSE_OUT

public static final String ON_MOUSE_OUT

See Also:

Constant Field Values

ON_KEY_PRESS

public static final String ON_KEY_PRESS

See Also:

Constant Field Values

ON_KEY_DOWN

public static final String ON_KEY_DOWN

See Also:

Constant Field Values

ON_KEY_UP

public static final String ON_KEY_UP

See Also:

Constant Field Values

ON_FOCUS

public static final String ON_FOCUS

some defined events for components that can get the focus

See Also:

Constant Field Values

ON_BLUR

public static final String ON_BLUR

See Also:

Constant Field Values

ON_LOAD

public static final String ON_LOAD

some defined events specially for the htmlpage

See Also:

Constant Field Values

ON_UNLOAD

public static final String ON_UNLOAD

See Also:

Constant Field Values

ON_SUBMIT

public static final String ON_SUBMIT

some defined events specially for the formcontainer

See Also:

Constant Field Values

ON_RESET

public static final String ON_RESET

See Also:

Constant Field Values

ON_SELECT

public static final String ON_SELECT

some defined events specially for textareas and inputfields

See Also:

Constant Field Values

ON_CHANGE

public static final String ON_CHANGE

some defined events specially for select lists

See Also:

Constant Field Values

viewMode

protected short viewMode

how should the component be rendered

browserMode

protected short browserMode

for which browser should the component be rendered

isSensitive

protected boolean isSensitive

shows if the component can listen to events

ID

public static final String ID

the id of attribute of a component

See Also:

Constant Field Values

parentElem

protected Element parentElem

the parent element of the components root

parent

protected Container parent

root

protected Element root

the root element of the internal JDOM-Tree of the component

label

protected Label label

the reference to the component, which is the label of this component

Constructor Detail

AbstractComponent

public AbstractComponent()

AbstractComponent

public AbstractComponent(Element root)

constructs a new component from an existing JDOM the root element must have an id attribute

AbstractComponent

public AbstractComponent(String name,
                         String id,
                         String className)

constructs a new empty component and creates an internal JDOM that consists of an empty root element

Parameters:

name - - the name of the root element

id - - the id of the component

className - - the name of the component class

AbstractComponent

public AbstractComponent(String name)

Method Detail

init

public void init(Element element)

Initialize the component with a jdom-tree.

Specified by:

init in interface Component

Parameters:

element - - the root-element of the tree, must not be null

init

public void init(String name)

init

public void init(String name,
                 String id,
                 String className)

initialize the component with an new jdom-tree

Specified by:

init in interface Component

Parameters:

name - - the name of the root-element of the tree, must not be null

id - - the id of the component

className - - the name of the component class

setAttribute

public Component setAttribute(String name,
                              String value)

sets the attribute to the component

Specified by:

setAttribute in interface Component

Parameters:

name - - the name of the attribute

value - - the value of the attribute

getAttribute

public String getAttribute(String name)

returs the value of an attribute

Specified by:

getAttribute in interface Component

Parameters:

name - - the name of the attribute

Returns:

- the value of the attribute

removeAttribute

public boolean removeAttribute(String name)

Remove the attribute from the component.

Specified by:

removeAttribute in interface Component

Parameters:

name - - the name of the attribute

Returns:

- true, if the attribute was found

setActionListener

public void setActionListener(String event,
                              String action)

Sets the action to an event. A synonym to setAttribute.

Specified by:

setActionListener in interface Component

Parameters:

event - the event to listen

action - the action to perform

setId

public void setId(String id)

set the unique identifier to a given value. Handle with care!

Specified by:

setId in interface Component

Parameters:

id - the new id of this component

getId

public String getId()

Specified by:

getId in interface Component

Returns:

- the unique identifier of the component

setName

public void setName(String name)

set the name to a given value.

Specified by:

setName in interface Component

Parameters:

name - - the new name of this component

getName

public String getName()

Specified by:

getName in interface Component

Returns:

- the name of the component

setRootName

public void setRootName(String name)

set the name of the root element to a given value.

Parameters:

name - - the new name of the root element

getRootName

public String getRootName()

Returns:

- the name of the root element

setLabel

public void setLabel(Label c)

sets the label component

Specified by:

setLabel in interface Component

Parameters:

c - - the label component

getLabel

public Label getLabel()

Specified by:

getLabel in interface Component

Returns:

- the label component of the component

setParentElement

public void setParentElement(Element parent)

sets the parent element of the components root

Specified by:

setParentElement in interface Component

Parameters:

parent - - the parent element

getParentElement

public Element getParentElement()

Specified by:

getParentElement in interface Component

Returns:

- the parent element of the components root

setParent

public void setParent(Container parent)

sets the parent container

Specified by:

setParent in interface Component

Parameters:

parent - - the parent container

getParent

public Container getParent()

Specified by:

getParent in interface Component

Returns:

- the parent container

setViewMode

public void setViewMode(short mode)

sets the viewMode

Specified by:

setViewMode in interface Component

Parameters:

mode - - the new viewMode

getViewMode

public short getViewMode()

Specified by:

getViewMode in interface Component

Returns:

- the viewMode of the component

setBrowserMode

public void setBrowserMode(short mode)

sets the browserMode

Specified by:

setBrowserMode in interface Component

Parameters:

mode - - the new browserMode

getBrowserMode

public short getBrowserMode()

Specified by:

getBrowserMode in interface Component

Returns:

- the browserMode of the component

setStyle

public void setStyle(String style)

Set the style

Specified by:

setStyle in interface Component

Parameters:

style - - the new style

getStyle

public String getStyle()

Specified by:

getStyle in interface Component

Returns:

- the style of the component

show

public String show()

Description copied from interface: Component

method for rendering the component as string

Specified by:

show in interface Component

Returns:

- the rendered component as String

show

public void show(PrintWriter pw)

prints the rendered component to a PrintWriter

Specified by:

show in interface Component

Parameters:

pw - - the Printwriter

toString

public String toString()

Returns the classname followed by a colon and the title attribute. The string representation is sometimes used for sorting, e.g. TableRenderer.

Specified by:

toString in interface Component

Overrides:

toString in class Object

Returns:

- the rendered component as string

clone

public Object clone()

returns a copy of the Component object

Specified by:

clone in interface Component

Overrides:

clone in class Object

Returns:

the Component clone

getRoot

public Element getRoot()

returns the root element of the internal JDOM

Specified by:

getRoot in interface Component

Returns:

the root element

setContent

public void setContent(Object o)

sets the content of the component

Specified by:

setContent in interface Component

Parameters:

o - any object where the string representation is used for rendering

getContent

public Object getContent()

Specified by:

getContent in interface Component

Returns:

the content object of the component

setNewLines

@Deprecated
public void setNewLines(boolean val)

Deprecated. method does nothing

setEncoding

@Deprecated
public void setEncoding(boolean val)

Deprecated. method does nothing

setExpandEmptyElements

@Deprecated
public void setExpandEmptyElements(boolean val)

Deprecated. method does nothing

setIndenting

@Deprecated
public void setIndenting(boolean val)

Deprecated. method does nothing

create

public static Component create(Element root)

Create element from dom

Parameters:

root -

Returns:

the new component

toggleClass

public Component toggleClass(String clazz,
                             boolean add)

Description copied from interface: Component

remove or add the given CSS class(es) from the list of existing CSS-classes depending on a condition

Specified by:

toggleClass in interface Component

Parameters:

clazz - blank separated list of CSS classes to be added/removed

add - - condition to add (true) or remove (false) the classes

Returns:

the current CSS classes

addClass

public Component addClass(String clazz)

Description copied from interface: Component

add the given CSS class(es) to the list of existing CSS-classes

Specified by:

addClass in interface Component

Parameters:

clazz - blank separated list of CSS classes to be added

Returns:

the current CSS classes

removeClass

public Component removeClass(String clazz)

Description copied from interface: Component

remove the given CSS class(es) from the list of existing CSS-classes

Specified by:

removeClass in interface Component

Parameters:

clazz - blank separated list of CSS classes to be removed

Returns:

the current CSS classes

setClass

public Component setClass(String clazz)

Description copied from interface: Component

set the CSS-class attribute to the given value

Specified by:

setClass in interface Component

Parameters:

clazz - blank separated list of CSS classes to be assigned

Returns:

the current CSS classes