From richfaces-svn-commits at lists.jboss.org Mon Aug 11 12:43:18 2008
Content-Type: multipart/mixed; boundary="===============0332422395328840886=="
MIME-Version: 1.0
From: richfaces-svn-commits at lists.jboss.org
To: richfaces-svn-commits at lists.jboss.org
Subject: [richfaces-svn-commits] JBoss Rich Faces SVN: r10028 - in
 trunk/docs/cdkguide/en/src/main: resources/examples and 1 other directory.
Date: Mon, 11 Aug 2008 12:43:17 -0400
Message-ID: <E1KSaUH-0001JI-Q7@committer01.frg.pub.inap.atl.jboss.com>

--===============0332422395328840886==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable

Author: artdaw
Date: 2008-08-11 12:43:17 -0400 (Mon, 11 Aug 2008)
New Revision: 10028

Added:
   trunk/docs/cdkguide/en/src/main/resources/examples/inputDate.xcss
   trunk/docs/cdkguide/en/src/main/resources/examples/resource-config.xml
Modified:
   trunk/docs/cdkguide/en/src/main/docbook/includes/register.xml
   trunk/docs/cdkguide/en/src/main/docbook/includes/skin.xml
   trunk/docs/cdkguide/en/src/main/resources/examples/InputDateRendererBase=
.java
Log:
https://jira.jboss.org/jira/browse/RF-3692 - Skinnability section was fixed=
, 'resource-config.xml file format' section was added.

Modified: trunk/docs/cdkguide/en/src/main/docbook/includes/register.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- trunk/docs/cdkguide/en/src/main/docbook/includes/register.xml	2008-08-1=
1 15:16:59 UTC (rev 10027)
+++ trunk/docs/cdkguide/en/src/main/docbook/includes/register.xml	2008-08-1=
1 16:43:17 UTC (rev 10028)
@@ -1,22 +1,117 @@
 <?xml version=3D"1.0" encoding=3D"UTF-8"?>
 <section id=3D"register" xreflabel=3D"register">
 <?dbhtml filename=3D"register.html"?>
-<sectioninfo>
-<keywordset>
-<keyword>register</keyword>
-<keyword>UI</keyword>
-<keyword>CDK</keyword>
-<keyword>Guide</keyword>
-</keywordset>
-</sectioninfo>
-<title>Component resources registration</title>
-<para>
- Registering component resources
-</para>
-<section id=3D"resconf">
-<title>resources-config.xml file format</title>
-<para>
-resources-config.xml file format
-</para>
-</section>
+	<sectioninfo>
+		<keywordset>
+			<keyword>register</keyword>
+			<keyword>UI</keyword>
+			<keyword>CDK</keyword>
+			<keyword>Guide</keyword>
+		</keywordset>
+	</sectioninfo>
+	<title>Component resources registration</title>
+	<para>
+		The <emphasis role=3D"bold"><property>&lt;inputDate&gt;</property></emph=
asis> component has a number of resources that should be registered =

+		in the <property>resource-config.xml</property> file. =

+		If the resource is registered, the RichFaces filter will send a request =
to the <property>ResourceBuilder</property> class =

+		in order to create and to deliver the resource. =

+	</para>
+	<para>
+		So, you need to proceed to the <property>inputDate/src/main/config/resou=
rces</property> directory and
+		register following resources in the <property>resource-config.xml</prope=
rty> file:
+	</para>
+	<itemizedlist>
+		<listitem>
+			<para>
+				an icon
+			</para>
+			<programlisting role=3D"XML"><![CDATA[...
+<resource>
+	<name>org/mycompany/renderkit/html/images/inputDate.png</name>
+	<path>org/mycompany/renderkit/html/images/inputDate.png</path>
+</resource>
+...]]></programlisting>
+		</listitem>
+		<listitem>
+			<para>
+				the <property>inputDate.xcss</property> file
+			</para>
+			<programlisting role=3D"XML"><![CDATA[...
+<resource>
+	<name>org/mycompany/renderkit/html/css/inputDate.xcss</name>
+	<path>org/mycompany/renderkit/html/css/inputDate.xcss</path>
+</resource>		=

+...]]></programlisting>
+		</listitem>
+		<listitem>
+			<para>
+				the <property>inputDate.js</property> file
+			</para>
+			<programlisting role=3D"XML"><![CDATA[...
+<resource>
+	<name>org/mycompany/renderkit/html/scripts/inputDate.js</name>
+	<path>org/mycompany/renderkit/html/scripts/inputDate.js</path>
+</resource>		=

+...]]></programlisting>
+		</listitem>
+	</itemizedlist>
+	<para>
+		<ulink url=3D"examples/resource-config.xml">Here</ulink> you could find =
a full example of the <property>resource-config.xml</property> =

+		for the <emphasis role=3D"bold"><property>&lt;inputDate&gt;</property></=
emphasis> component.
+	</para>
+	<section id=3D"resconf">
+		<title>resource-config.xml file format</title>
+		<para>
+			The <property>resource-config.xml</property> is a file for resources re=
gistration. =

+			Note, that the <property>resource-config.xml</property> should appear i=
n the <property>META-INF</property> folder after the
+			component building.
+		</para>
+		<para>
+			This file has the <emphasis role=3D"bold"><property>&lt;resource-config=
&gt;</property></emphasis> root element =

+			with nested <emphasis role=3D"bold"><property>&lt;resource&gt;</propert=
y></emphasis> elements. =

+		</para>
+		<para>
+			It is possible to register static resources (images, JavaScript , CSS, =
XCSS, SWF, (X)HTML, XML, Log files), dynamic created images,
+			component-incapsulated, JAR resources, etc.
+		</para>
+		<para>
+			Here is a simple example of the image registration:
+		</para>
+		<programlisting role=3D"XML"><![CDATA[...
+<resource>
+	<name>org/mycompany/renderkit/html/images/inputDate.png</name>
+	<path>org/mycompany/renderkit/html/images/inputDate.png</path>
+</resource>
+...]]></programlisting>
+		<para>
+			There are two element in the example above:
+			an obligatory <emphasis role=3D"bold"><property>&lt;name&gt;</property>=
</emphasis> element which defines resource name and =

+			a <emphasis role=3D"bold"><property>&lt;path&gt;</property></emphasis> =
element which defines the path to the resource.
+			The <emphasis role=3D"bold"><property>&lt;path&gt;</property></emphasis=
> element is optional as it is possible to register =

+			dynamic resources with the <emphasis><property>&quot;class&quot;</prope=
rty></emphasis> attribute.
+			For example you could register dynamic created image as it is shown in =
the following example:
+		</para>
+		<programlisting role=3D"XML"><![CDATA[...
+<resource class=3D"org.mycompany.renderkit.html.images.inputDate">
+	<name>org.mycompany.renderkit.html.images.inputDate</name>
+</resource>
+...]]></programlisting>
+
+				<!--programlisting role=3D"XML"><![CDATA[...
+<resource>
+	<name></name>
+	<path></path>
+	<cacheable></cacheable>
+	<session-aware></session-aware>
+	<property>
+		<name></name>
+	</property>
+	<content-type></content-type>
+	<renderer>
+		<content-type></content-type>
+	</renderer>
+</resource>		=

+...]]></programlisting-->
+
+	</section>
 </section>
\ No newline at end of file

Modified: trunk/docs/cdkguide/en/src/main/docbook/includes/skin.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- trunk/docs/cdkguide/en/src/main/docbook/includes/skin.xml	2008-08-11 15=
:16:59 UTC (rev 10027)
+++ trunk/docs/cdkguide/en/src/main/docbook/includes/skin.xml	2008-08-11 16=
:43:17 UTC (rev 10028)
@@ -1,28 +1,75 @@
 <?xml version=3D"1.0" encoding=3D"UTF-8"?>
 <section id=3D"skin" xreflabel=3D"skin">
-<?dbhtml filename=3D"skin.html"?>
-<sectioninfo>
-<keywordset>
-<keyword>skin</keyword>
-<keyword>UI</keyword>
-<keyword>CDK</keyword>
-<keyword>Guide</keyword>
-</keywordset>
-</sectioninfo>
-<title>Skinnability</title>
-<para>
- creation
-</para>
-<section>
-<title>XCSS Format</title>
-<para>
-XCSS
-</para>
-</section>
-<section>
-<title>Dynamic images generation</title>
-<para>
-XCSS
-</para>
-</section>
+	<?dbhtml filename=3D"skin.html"?>
+	<sectioninfo>
+		<keywordset>
+			<keyword>skin</keyword>
+			<keyword>UI</keyword>
+			<keyword>CDK</keyword>
+			<keyword>Guide</keyword>
+		</keywordset>
+	</sectioninfo>
+	<title>Skinnability</title>
+	<para>
+		One of the significant features of the Component Development Kit (CDK) i=
s a skins-based technology which helps you to create a modern rich user int=
erface look-and-feel.
+		RichFaces has a number of predefined skins you could use wtih the <empha=
sis role=3D"bold"><property>&lt;inputDate&gt;</property></emphasis> compone=
nt.
+		But if you want to create your own skin, please, read carefully =

+		the <property>&quot;Skinnability&quot;</property> section of the =

+		<ulink url=3D"http://www.jboss.org/file-access/default/members/jbossrich=
faces/freezone/docs/devguide/en/html/ArchitectureOverview.html#Skinnability=
">RichFaces Developer Guide</ulink>. You could find all neccesary informati=
on about =

+		<property>Built-in skinnability in RichFaces</property>, <property>XCSS =
file format</property>, <property>Plug-n-Skin feature</property>, etc. ther=
e.
+	</para>
+	<para>
+		According to the  <emphasis role=3D"bold"><property>&lt;inputDate&gt;</p=
roperty></emphasis> markup you need to
+		define following selectors and classes in the <property>inputDate.xcss</=
property>:
+	</para>	=

+	<itemizedlist>
+		<listitem>
+			<para>
+				<code>.my-inputDate-input</code>, <code>.my-inputDate-icon</code> sele=
ctors 	=

+			</para>
+			<programlisting role=3D"XML"><![CDATA[...
+<u:selector name=3D".my-inputDate-input">
+	<u:style name=3D"border-color" skin=3D"panelBorderColor"/>
+	<u:style name=3D"background-color" skin=3D"controlBackgroundColor"/>
+	<u:style name=3D"color" skin=3D"controlTextColor"/>
+	<u:style name=3D"font-family" skin=3D"generalFamilyFont"/>
+	<u:style name=3D"font-size" skin=3D"generalSizeFont"/>
+</u:selector>
+<u:selector name=3D".my-inputDate-icon">
+	<u:style name=3D"border-color" skin=3D"panelBorderColor"/>
+	<u:style name=3D"background-image">
+		<f:resource f:key=3D"/org/mycompany/renderkit/html/images/inputDate.png"=
 />
+	</u:style>
+</u:selector>
+...]]></programlisting>
+		</listitem>
+				<listitem>
+			<para>
+				<code>.my-inputDate-input</code>, <code>.my-inputDate-icon</code>, and=
 <code>.my-inputDate-caption</code> classes 	=

+			</para>
+			<programlisting role=3D"CSS"><![CDATA[...
+.my-inputDate-input{
+	background-color: #EBEBE4;
+	border: 1px solid #7F9DB9;
+	float:left;
+}
+.my-inputDate-icon{
+	margin-left: 3px;
+}
+.my-inputDate-caption{
+	color: #000000;
+}
+...]]></programlisting>
+		</listitem>
+	</itemizedlist>
+	<para>
+		You could find a complete <property>inputDate.xcss</property> <ulink url=
=3D"examples/inputDate.xcss">here</ulink>.
+	</para>	=

+	=

+	<!--section>
+		<title>Dynamic images generation</title>
+		<para>
+		Dynamic images generation
+		</para>
+	</section-->
 </section>
\ No newline at end of file

Modified: trunk/docs/cdkguide/en/src/main/resources/examples/InputDateRende=
rerBase.java
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- trunk/docs/cdkguide/en/src/main/resources/examples/InputDateRendererBas=
e.java	2008-08-11 15:16:59 UTC (rev 10027)
+++ trunk/docs/cdkguide/en/src/main/resources/examples/InputDateRendererBas=
e.java	2008-08-11 16:43:17 UTC (rev 10028)
@@ -15,7 +15,7 @@
 import org.mycompany.component.UIInputDate;
 =

 =

-public abstract class InputDateRendererBase extends HeaderResourcesRendere=
rBase{
+public abstract class InputDateRendererBase  extends HeaderResourcesRender=
erBase{
 =

 	public void decode(FacesContext context, UIComponent component){
 		ExternalContext external =3D context.getExternalContext();

Added: trunk/docs/cdkguide/en/src/main/resources/examples/inputDate.xcss
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- trunk/docs/cdkguide/en/src/main/resources/examples/inputDate.xcss	     =
                   (rev 0)
+++ trunk/docs/cdkguide/en/src/main/resources/examples/inputDate.xcss	2008-=
08-11 16:43:17 UTC (rev 10028)
@@ -0,0 +1,37 @@
+<?xml version=3D"1.0" encoding=3D"UTF-8"?>
+<f:template xmlns:f=3D'http:/jsf.exadel.com/template'
+   xmlns:u=3D'http:/jsf.exadel.com/template/util'
+   xmlns=3D"http://www.w3.org/1999/xhtml" >
+   <f:verbatim>
+   <![CDATA[
+   .my-inputDate-input{
+		background-color: #EBEBE4;
+		border: 1px solid #7F9DB9;
+		float:left;
+   }
+   =

+   .my-inputDate-icon{
+   		margin-left: 3px;
+   }
+   =

+   .my-inputDate-caption{
+   		color: #000000;
+   }
+   ]]>
+    </f:verbatim>
+   =

+   	<u:selector name=3D".my-inputDate-input">
+		<u:style name=3D"border-color" skin=3D"panelBorderColor"/>
+		<u:style name=3D"background-color" skin=3D"controlBackgroundColor"/>
+		<u:style name=3D"color" skin=3D"controlTextColor"/>
+		<u:style name=3D"font-family" skin=3D"generalFamilyFont"/>
+		<u:style name=3D"font-size" skin=3D"generalSizeFont"/>
+	</u:selector>
+	<u:selector name=3D".my-inputDate-icon">
+		<u:style name=3D"border-color" skin=3D"panelBorderColor"/>
+		<u:style name=3D"background-image">
+			<f:resource f:key=3D"/org/mycompany/renderkit/html/images/inputDate.png=
" />
+		</u:style>
+	</u:selector>
+	=

+</f:template>
\ No newline at end of file


Property changes on: trunk/docs/cdkguide/en/src/main/resources/examples/inp=
utDate.xcss
___________________________________________________________________
Name: svn:executable
   + *

Added: trunk/docs/cdkguide/en/src/main/resources/examples/resource-config.x=
ml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- trunk/docs/cdkguide/en/src/main/resources/examples/resource-config.xml	=
                        (rev 0)
+++ trunk/docs/cdkguide/en/src/main/resources/examples/resource-config.xml	=
2008-08-11 16:43:17 UTC (rev 10028)
@@ -0,0 +1,15 @@
+<?xml version=3D"1.0" encoding=3D"UTF-8"?>
+<resource-config>
+    <resource>
+        <name>org/mycompany/renderkit/html/images/inputDate.png</name>
+        <path>org/mycompany/renderkit/html/images/inputDate.png</path>
+    </resource>
+    <resource>
+        <name>org/mycompany/renderkit/html/scripts/inputDate.js</name>
+        <path>org/mycompany/renderkit/html/scripts/inputDate.js</path>
+    </resource>
+    <resource>
+        <name>org/mycompany/renderkit/html/css/inputDate.xcss</name>
+        <path>org/mycompany/renderkit/html/css/inputDate.xcss</path>
+    </resource>
+</resource-config>
\ No newline at end of file


Property changes on: trunk/docs/cdkguide/en/src/main/resources/examples/res=
ource-config.xml
___________________________________________________________________
Name: svn:executable
   + *


--===============0332422395328840886==--