corelib.services.web.components
Class VisualComponent

java.lang.Object
  corelib.services.web.components.WebComponent
      corelib.services.web.components.VisualComponent

Direct Known Subclasses:

Accordion, AccordionMenu, CodeColorer, CurrentYear, DataGrid, Diagram, Form, FormElement, FrenchBankIdentity, GenericTag, Html, Image, InternationalBankIdentity, Label, Link, LoginForm, MailEditor, MailingListChooser, MailingListEditor, Menu, MenuBar, MenuItem, MenuSeparator, OutputText, Panel, ProgressBar, Repeater, SplitPane, Tab, TabbedPane, TemplatedComponent, ToolTip, ValidationSummary, Validator

public abstract class VisualComponent
extends WebComponent

This class represents web components that have HTML rendering in the web page.

Since:

0.1.0

Author:

Dominique Liard

Field Summary

protected java.lang.String	cssClass
protected java.lang.String	cssStyle
protected java.lang.String	toolTipText
protected boolean	visible

Fields inherited from class corelib.services.web.components.WebComponent

dataBindings, webPage, xmlNode

Constructor Summary

VisualComponent()

Method Summary

void	component_postRender(WebPageEvent webPageEvent)
void	component_preRender(WebPageEvent webPageEvent)
void	component_renderBegin(WebPageEvent webPageEvent)
void	component_renderChildren(WebPageEvent webPageEvent)
void	component_renderEnd(WebPageEvent webPageEvent)
protected void	component_renderJavascriptLocalisation() Generate a Javascript line to find component client node
protected static java.lang.String	encodeAttributeValue(java.lang.String value)
java.lang.String	getCssClass() Returns the CSS class (or all CSS classes) used by this component.
java.lang.String	getCssStyle() Returns the text representation of CSS style declarations for this component.
java.lang.String	getOnClickListener()
protected java.lang.StringBuilder	getSharedAttributesHtmlEncoding()
java.lang.String	getToolTipText()
boolean	isVisible() Returns the visibility of this visual component.
protected void	renderElement(java.io.PrintWriter out, org.w3c.dom.Node node, WebPageEvent webPageEvent)
void	setCssClass(java.lang.String cssClass) Changes the CSS class used by this component.
void	setCssStyle(java.lang.String cssStyle) Changes the text representation of CSS style declarations for this component.
void	setOnClickListener(java.lang.String onClick)
void	setToolTipText(java.lang.String toolTipText)
void	setVisible(boolean visible) Changes the visibility of this visual component.

Methods inherited from class corelib.services.web.components.WebComponent

addBindingExpression, addChildComponent, component_init, component_load, component_preRepeaterDuplications, getChildComponents, getDataBinding, getElementsByTagName, getId, getWebPage, getXmlNode, setId, setWebPage, setXmlNode

Methods inherited from class java.lang.Object

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

Field Detail

cssStyle

protected java.lang.String cssStyle

cssClass

protected java.lang.String cssClass

toolTipText

protected java.lang.String toolTipText

visible

protected boolean visible

Constructor Detail

VisualComponent

public VisualComponent()

Method Detail

getCssStyle

public java.lang.String getCssStyle()

Returns the text representation of CSS style declarations for this component.

Returns:

The text representation of CSS style declarations.

See Also:

setCssStyle(String), getCssClass()

setCssStyle

public void setCssStyle(java.lang.String cssStyle)

Changes the text representation of CSS style declarations for this component.

Parameters:

cssStyle - the new text representation of CSS style declarations.

See Also:

getCssStyle(), setCssClass(String)

getCssClass

public java.lang.String getCssClass()

Returns the CSS class (or all CSS classes) used by this component. If more CSS classes are used, each class is separated by a space character.

Returns:

The CSS class(es) of the component.

See Also:

setCssClass(String), getCssStyle()

setCssClass

public void setCssClass(java.lang.String cssClass)

Changes the CSS class used by this component. In fact, this property can defines more than one CSS class. In this case, separe each CSS class by a space character.

Parameters:

cssClass - The new CSS class(es) used by this component.

See Also:

getCssClass(), setCssStyle(String)

getToolTipText

public java.lang.String getToolTipText()

setToolTipText

public void setToolTipText(java.lang.String toolTipText)

isVisible

public boolean isVisible()

Returns the visibility of this visual component. Notes that if a visual component is not visible, its corresponding HTML is not send to the browser.

Returns:

The visibility of this visual component.

setVisible

public void setVisible(boolean visible)

Changes the visibility of this visual component. Notes that if a visual component is not visible, its corresponding HTML is not send to the browser.

Parameters:

visible - The new visibility of this visual component.

getOnClickListener

public java.lang.String getOnClickListener()

setOnClickListener

public void setOnClickListener(java.lang.String onClick)

getSharedAttributesHtmlEncoding

protected java.lang.StringBuilder getSharedAttributesHtmlEncoding()

component_preRender

public void component_preRender(WebPageEvent webPageEvent)

component_renderBegin

public void component_renderBegin(WebPageEvent webPageEvent)

component_renderChildren

public void component_renderChildren(WebPageEvent webPageEvent)

component_renderEnd

public void component_renderEnd(WebPageEvent webPageEvent)

component_postRender

public void component_postRender(WebPageEvent webPageEvent)

component_renderJavascriptLocalisation

protected void component_renderJavascriptLocalisation()

Generate a Javascript line to find component client node

renderElement

protected void renderElement(java.io.PrintWriter out,
                             org.w3c.dom.Node node,
                             WebPageEvent webPageEvent)

encodeAttributeValue

protected static java.lang.String encodeAttributeValue(java.lang.String value)