echopoint.ui
Class Installer

java.lang.Object
  echopoint.ui.Installer

All Implemented Interfaces:

java.io.Serializable

public class Installer

extends java.lang.Object

implements java.io.Serializable

This class can be used to register all of the EchoPoint Peer classes or individually.

The general usage is :
static {
Installer.register();
}
This should be done inside the declaration of your EchoServer class. You must register the EchoPoint components before you can use them. This is an Echo 1.0 requirement. As of Echo 1.1, there is a automatic peer discovery mechanims and hence the need for the Installer.register() methods goes away.

See Also:

Serialized Form

Field Summary

static java.lang.String	ECHOPOINT_VERSION the current version of EchoPoint
static nextapp.echoservlet.util.PropertyMap	echoPointProperties Contains EchoPoint UI peer related properties from the special class resource file echopoint.ui.Installer.properties.

Constructor Summary

Installer()

Method Summary

static void	endComment(java.lang.Object peer, nextapp.echoservlet.html.Element parent) Creates an end comment at the end of a component UI output depending on whether the Installer.properties file has a "useHtmlComments" entry.
static java.lang.String	getVersion() Returns the current version number of EchoPoint
static void	register() Registers all the Peer classes in this package at once
static void	register(java.lang.Class componentClass) Registers a single Peer classes in this package based on its matching front end Component.
static void	setProperty(java.lang.String propertyName, java.lang.String value) This method can be used to "overrride" the values of the properties in the Installer.properties file.
static void	startComment(java.lang.Object peer, nextapp.echoservlet.html.Element parent) Creates a start comment at the beginning of a component UI output depending on whether the Installer.properties file has a "useHtmlComments" entry.

Methods inherited from class java.lang.Object

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

Field Detail

ECHOPOINT_VERSION

public static java.lang.String ECHOPOINT_VERSION

the current version of EchoPoint

echoPointProperties

public static nextapp.echoservlet.util.PropertyMap echoPointProperties

Contains EchoPoint UI peer related properties from the special class resource file echopoint.ui.Installer.properties.

Constructor Detail

Installer

public Installer()

Method Detail

getVersion

public static java.lang.String getVersion()

Returns the current version number of EchoPoint

register

public static void register()

Registers all the Peer classes in this package at once

register

public static void register(java.lang.Class componentClass)

Registers a single Peer classes in this package based on its matching front end Component. For example it could be used as :
static { Installer.register(Timer.class); Installer.register(TitleBar.class); }

startComment

public static void startComment(java.lang.Object peer,
                                nextapp.echoservlet.html.Element parent)

Creates a start comment at the beginning of a component UI output depending on whether the Installer.properties file has a "useHtmlComments" entry.

Parameters:

peer - - the UI peer

parent - - the parent HTML element

endComment

public static void endComment(java.lang.Object peer,
                              nextapp.echoservlet.html.Element parent)

Creates an end comment at the end of a component UI output depending on whether the Installer.properties file has a "useHtmlComments" entry.

Parameters:

peer - - the UI peer

parent - - the parent HTML element

setProperty

public static void setProperty(java.lang.String propertyName,
                               java.lang.String value)

This method can be used to "overrride" the values of the properties in the Installer.properties file.

Boolean values are denoted by "1" or not "1", so for exmaple to turn on HTML comments one would call setProperty("useHtmlComments","1");

Parameters:

propertyName - - the name of the property to override

value - - a new value