Author: nbelaevski Date: 2007-07-29 09:16:26 -0400 (Sun, 29 Jul 2007) New Revision: 1908 Modified: trunk/sandbox/ui/message/src/main/java/org/richfaces/component/UIRichMessages.java trunk/sandbox/ui/message/src/main/java/org/richfaces/renderkit/html/RichMessageBaseRenderer.java Log: TODOs added Modified: trunk/sandbox/ui/message/src/main/java/org/richfaces/component/UIRichMessages.java =================================================================== --- trunk/sandbox/ui/message/src/main/java/org/richfaces/component/UIRichMessages.java 2007-07-28 01:22:09 UTC (rev 1907) +++ trunk/sandbox/ui/message/src/main/java/org/richfaces/component/UIRichMessages.java 2007-07-29 13:16:26 UTC (rev 1908) @@ -22,8 +22,10 @@ public static String HEADER_LOCATION_RIGHT = "right"; + //TODO nick - anton - make wroteTable local renderer variable private boolean wroteTable = false; + //TODO nick - anton - make isIteratorLayout local renderer variable. do we need it at all? private boolean isIteratorLayout = false; private boolean isPassed = false; Modified: trunk/sandbox/ui/message/src/main/java/org/richfaces/renderkit/html/RichMessageBaseRenderer.java =================================================================== --- trunk/sandbox/ui/message/src/main/java/org/richfaces/renderkit/html/RichMessageBaseRenderer.java 2007-07-28 01:22:09 UTC (rev 1907) +++ trunk/sandbox/ui/message/src/main/java/org/richfaces/renderkit/html/RichMessageBaseRenderer.java 2007-07-29 13:16:26 UTC (rev 1908) @@ -20,6 +20,51 @@ * @author Anton Belevich * */ +//TODO nick - anton - please review our naming conventions: + +//Naming Conventions +//During the development we should follow the naming convention for all project stuff. The rules are defined below: +// +// +//By default, a geterator expects the following structure for Java classes : +// +//<prefix>.component.Abstract<Name> ia an optional abstract superclass for a JSF component. To avoid manual writing for EL-enabled getters/setters, saveState/restoreState methods, listener-related methods etc, a developer can create an abstract class, and a generator creates the implementation. +//<prefix>.component.UI<Name> is a Base component class. It can be generated from the abstract superclass or created by a developer. +//<prefix>.component.<markup>.<Markup><RendererName>renderer-specific generated component( where the markup is a render-kit specific generation name, such as html | xml | wml ). In addition to the UI Component class, contains Java Bean getter/setter methods for renderer-specific attributes. This class is generated by CDK. +//<prefix>.<Name> - JSF UI component-type. Can be provided in the configuration or calculated from a component class name. +//<prefix>.<Markup><RendererName> - renderer-specific JSF component-type. Can be provided in the configuration or calculated from the renderer name. +//<prefix>.renderkit.<RendererName>RendererBase - optional Renderer superclass, implements methods from template renderer used by generated. Created by a component developer. +//<prefix>.renderkit.<markup>.<RendererName>Renderer is a generated renderer. +//<prefix>.<RendererName>Renderer - JSF renderer-type. Can be provided in the configuration or calculated from a renderer name. +//<prefix>.<Markup><RendererName>.xml is a template for generating the renderer class. jspx - like syntax is used. Provided by a component developer. +//<prefix>.taglib.<RendererName>Tag - JSP tag class. +//<prefix>.taglib.<RendererName>TagHandler is a facelets tag handler class. +//<renderername> - JSP/facelets tag name. +//For components, that uses JSF events : +// +//<prefix>.event.<Event>Event is a event class. Provided by component a developer. +//<prefix>.event.<Event>Listener is an event listener interface. Can be generated by CDK +//process<Event> is an event processing method name in a listener interface. +//<prefix>.event.<Event>Source - is an interface for an event processing component ( with methods add<Event>Listener(<Event>Listener listener ) , remove<Event>Listener.... ) +//<prefix>.event.<Event>EventWrapper - wrapper class. Uses for binding listener's EL-expression in user's beans. +//<prefix>.taglib.<Event>ListenerTag - JSP tag class for a creating listener instance. A parent tag must creates component implementing Source interface. +//<prefix>.taglib.<Event>ListenerTagHandler is a facelets tag class for creation of listener instance. +// +// +//Definitions that are used in this structure ( uppercase symbols means Java names notation, for name "foo" <name> mean "foo", and <Name> - "Foo" ): +// +//<prefix> +//is a common library name ( for example, base JSF components use <javax.faces> prefix ). Value for prefix get from an abstract component package or a renderer template path. +//<name> +//is a name for base component ( for UIInput component <name> is "input" ). Value for a component name generator can got from UI... or Abstract... class name. +//<markup> +//is a render-kit generated a content name, "html" for HTML/XHTML pages, "wml" for mobile content etc. It must be provided in the render-kit description by ant task or maven POM. By default, "html" is used +//<rendererName> +//- name of renderer for concreting a visual component implementation, e.g. "commandButton" , "panelGroup" etc. A generator can take rendererName from a template file name. +//<event> +//is a name for Faces Event ( "action" for all ActionSource components like UICommand ). Can be provided in the component configuration, or got from the implemented ...Source interface. + +//TODO nick - anton - please consider using jspx templates public abstract class RichMessageBaseRenderer extends HeaderResourcesRendererBase{ protected static final Log log = LogFactory.getLog(RichMessageHtmlBaseRenderer.class);