Author: smukhina
Date: 2007-09-05 10:01:07 -0400 (Wed, 05 Sep 2007)
New Revision: 2767
Modified:
trunk/samples/richfaces-demo/src/main/webapp/richfaces/calendar/jsAPI.xhtml
trunk/samples/richfaces-demo/src/main/webapp/richfaces/calendar/model.xhtml
trunk/samples/richfaces-demo/src/main/webapp/richfaces/log/usage.xhtml
trunk/samples/richfaces-demo/src/main/webapp/richfaces/messages/usage.xhtml
trunk/samples/richfaces-demo/src/main/webapp/richfaces/outputPanel/usage.xhtml
Log:
http://jira.jboss.com/jira/browse/RF-524
language is checked
Modified: trunk/samples/richfaces-demo/src/main/webapp/richfaces/calendar/jsAPI.xhtml
===================================================================
--- trunk/samples/richfaces-demo/src/main/webapp/richfaces/calendar/jsAPI.xhtml 2007-09-05
13:55:36 UTC (rev 2766)
+++ trunk/samples/richfaces-demo/src/main/webapp/richfaces/calendar/jsAPI.xhtml 2007-09-05
14:01:07 UTC (rev 2767)
@@ -1,65 +1,65 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html
xmlns="http://www.w3.org/1999/xhtml"
-
xmlns:ui="http://java.sun.com/jsf/facelets"
-
xmlns:h="http://java.sun.com/jsf/html"
-
xmlns:f="http://java.sun.com/jsf/core"
-
xmlns:a4j="http://richfaces.org/a4j"
-
xmlns:rich="http://richfaces.org/rich">
- <ui:composition template="/templates/component-sample.xhtml">
- <ui:define name="sample">
-
- <p>
- Calendar object JavaScript API supports the following calls:
- <ul>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html
xmlns="http://www.w3.org/1999/xhtml"
+
xmlns:ui="http://java.sun.com/jsf/facelets"
+
xmlns:h="http://java.sun.com/jsf/html"
+
xmlns:f="http://java.sun.com/jsf/core"
+
xmlns:a4j="http://richfaces.org/a4j"
+
xmlns:rich="http://richfaces.org/rich">
+ <ui:composition template="/templates/component-sample.xhtml">
+ <ui:define name="sample">
+
+ <p>
+ Calendar object JavaScript API supports the following calls:
+ <ul>
<li>
<b>getCurrentDate()</b> returns the full date currently being viewed
</li>
<li>
- <b>getCurrentMonth(asMonthLabel)</b> returns number of the month currently
being viewed(for <b>asMonthLabel</b> true - returns month as its label)
+ <b>getCurrentMonth(asMonthLabel)</b> returns a number of the month
currently being viewed(for <b>asMonthLabel</b> true - returns month as its
label)
</li>
<li>
- <b>getCurrentYear()</b> returns number of the year currently being viewed
+ <b>getCurrentYear()</b> returns a number of the year currently being
viewed
</li>
<li>
- <b>changeCurrentDate(yearOffset, monthOffset)</b> sets new current month
to be displayed.
+ <b>changeCurrentDate(yearOffset, monthOffset)</b> sets a new current month
to be displayed.
</li>
<li>
- <b>doCollapse(), doExpand()</b> collapse or expand calendar in popup
mode.
+ <b>doCollapse(), doExpand()</b> collapse or expand the calendar in a popup
mode.
</li>
<li>
- <b>doSwitch()</b> inverts state for the popup calendar.
+ <b>doSwitch()</b> inverts a state for the popup calendar.
</li>
<li>
- <b>getNextMonth(asMonthLabel), getPreviousMonth(asMonthLabel)</b> returns
previous and next month for the currently being viewed.
+ <b>getNextMonth(asMonthLabel), getPreviousMonth(asMonthLabel)</b> returns
the previous and next month for the currently being viewed one.
</li>
<li>
- <b>getNextYear, getPreviousYear</b> returns previous and next Years for
the currently being viewed.
+ <b>getNextYear, getPreviousYear</b> returns the previous and next years
for the currently being viewed one.
</li>
<li>
- <b>getSelectedDate(), getSelectedDateString(pattern)</b> returns currently
selected date as date or as String. In case of empty pattern - return in current locale
pattern.
+ <b>getSelectedDate(), getSelectedDateString(pattern)</b> returns the
currently selected date as date or as String. In case of empty pattern, it is returned in
the current locale pattern.
</li>
<li>
- <b>nextMonth()</b> navigates to next month
+ <b>nextMonth()</b> navigates to the next month
</li>
<li>
- <b>nextYear()</b> navigates to next year
+ <b>nextYear()</b> navigates to the next year
</li>
<li>
- <b>prevMonth()</b> navigates to previous month
+ <b>prevMonth()</b> navigates to the previous month
</li>
<li>
- <b>prevYear()</b> navigates to previous year
+ <b>prevYear()</b> navigates to the previous year
</li>
<li>
<b>render(), renderFooter(), renderOptionalFooter(), renderHeader(),
renderOptionalHeader()</b> - functions to initiate cliend side rendering of the
calendar or additional elements.
</li>
<li>
- <b>resetSelectedDate()</b> - clears selected day value.
+ <b>resetSelectedDate()</b> - clears a selected day value.
</li>
<li>
- <b>selectDate(date, noUpdate, eventData)</b> selects the date specified.
If the date isn't in current
- month, performs request to select. if noUpdate true - request will not fired for data
- only client side rendering will be invoked.
+ <b>selectDate(date, noUpdate, eventData)</b> selects the date specified.
If the date isn't in the current
+ month, performs a request to select some. if noUpdate is true, a request isn't
fired for data, only client side rendering is invoked.
</li>
<li>
<b>showSelectedDate()</b> switch calendar to show currently selected
date.
@@ -67,26 +67,26 @@
<li>
<b>today(noUpdate, noHighlight)</b> switch calendar to todayDate. If
parameters - true, request will not be fired to switch, and additional highlighting will
be off.
</li>
- </ul>
- </p>
- <p>
- You can access the calendar object using
<code>$(calendar_client_id).component</code>
- call from any place outside of the component itself.
- </p>
-
- <p> <dl><dt>If you develop the macrodefinition for calendar object,
you can use:</dt>
- <dd><code>Richfaces.invokeOnComponent('calendar',element,api_function_name)</code></dd>
- <dt>For example, the following call is
- used on the "Next Year" button on the popup calendar panel:</dt>
- <dd><code>Richfaces.invokeOnComponent('calendar',this,'nextYear');
</code></dd>
- The second parameter
- is an element inside the calendar. The Richfaces.invokeOnComponent tries to find
- the component in the parents hierarchy with type specified with the first parameter
and
- invokes the function defined with the third parameter.
- </dl>
- </p>
-
- </ui:define>
-
- </ui:composition>
-</html>
+ </ul>
+ </p>
+ <p>
+ You can access the calendar object using
<code>$(calendar_client_id).component</code>
+ call from any place outside of the component itself.
+ </p>
+
+ <p> <dl><dt>If you develop the macrodefinition for the calendar
object, you can use:</dt>
+ <dd><code>Richfaces.invokeOnComponent('calendar',element,api_function_name)</code></dd>
+ <dt>For example, the following call is
+ used on the "Next Year" button on the popup calendar panel:</dt>
+ <dd><code>Richfaces.invokeOnComponent('calendar',this,'nextYear');
</code></dd>
+ The second parameter
+ is an element inside the calendar. Richfaces.invokeOnComponent tries to find
+ the component in the parents hierarchy with type specified with the first parameter
and
+ invokes the function defined with the third parameter.
+ </dl>
+ </p>
+
+ </ui:define>
+
+ </ui:composition>
+</html>
Modified: trunk/samples/richfaces-demo/src/main/webapp/richfaces/calendar/model.xhtml
===================================================================
--- trunk/samples/richfaces-demo/src/main/webapp/richfaces/calendar/model.xhtml 2007-09-05
13:55:36 UTC (rev 2766)
+++ trunk/samples/richfaces-demo/src/main/webapp/richfaces/calendar/model.xhtml 2007-09-05
14:01:07 UTC (rev 2767)
@@ -15,34 +15,33 @@
<p>CalendarDataModel has the following methods:
<ul>
<li><b>CalendarDataModelItem[] getData(Date[]) </b> is called
- every time when components will need next block of CalendarDataItems.
- That may happens when calendar rendered, or when user navigate to
- next(previous) month or in any other case when calendar renders. This
- method will be called in Ajax mode when Calendar renders new page.</li>
- <li><b>Object getToolTip(Date)</b> uses when tool tips are
+ every time when components need the next block of CalendarDataItems.
+ That may happens when the calendar is rendered, or when you navigate to the
+ next/previous month or in any other case when the calendar is rendered. This
+ method is called in an Ajax mode when the calendar renders a new page.</li>
+ <li><b>Object getToolTip(Date)</b> is used when tool tips are
displayed in "single" mode.</li>
</ul>
</p>
<p>CalendarDataModelItem provides the following methods:
<ul>
<li><b>Boolean isEnabled()</b> returns true if date is
- "selectable" on calendar, default implementation return true</li>
- <li><b>String getStyleClass()</b> returns String that will be
- appended to style class for that date span. For example it may be
- "relevant holyday" that mean class will be like "rich-cal-day
- relevant holyday". Default implementation return empty string.</li>
+ "selectable" on the calendar, the default implementation returns
true</li>
+ <li><b>String getStyleClass()</b> returns String that is
+ appended to a style class for the date span. For example it may be
+ "relevant holiday" that mean a class lools like "rich-cal-day
+ relevant holiday". The default implementation returns an empty
string.</li>
<li><b>Object getData()</b> returns any additional payload that
- must be JSON-serialazable object. May be used in custom date
- representation on calendar (inside custom facet).</li>
- <li><b>Boolean hasToolTip()</b> returns true if given date has
- an associated with it tooltip data. Default implementation return
+ must be a JSON-serializable object. It may be used in the custom date
+ representation on the calendar (inside the custom facet).</li>
+ <li><b>Boolean hasToolTip()</b> returns true if the given date has
+ an associated one with it tooltip data. The default implementation returns
false.</li>
- <li><b>Object getToolTip()</b> returns tool tip data that will
- be used in "batch" tooltip loading mode.</li>
+ <li><b>Object getToolTip()</b> returns tool tip data that is used in
a "batch" tooltip loading mode.</li>
</ul>
</p>
<p>
- <b>Note: </b><i>Tooltips and date disablement isn't supported in
current implementation at client side. Will be implemented in next releases.</i>
+ <b>Note: </b><i>Tooltips and date disablement isn't supported in
the current implementation on the client side. It will be implemented in the next
releases.</i>
</p>
Modified: trunk/samples/richfaces-demo/src/main/webapp/richfaces/log/usage.xhtml
===================================================================
--- trunk/samples/richfaces-demo/src/main/webapp/richfaces/log/usage.xhtml 2007-09-05
13:55:36 UTC (rev 2766)
+++ trunk/samples/richfaces-demo/src/main/webapp/richfaces/log/usage.xhtml 2007-09-05
14:01:07 UTC (rev 2767)
@@ -8,12 +8,12 @@
<ui:composition template="/templates/component-sample.xhtml">
<ui:define name="sample">
<p>
- Log component allows the developer to inspect client side activities
- during Ajax request. It shows reuqest data, response data, DOM
- tree changes on update and other usefull debug information.
+ Log component allows you to inspect client side activities
+ during an Ajax request. It shows reuqest data, response data, DOM
+ tree changes on update and other useful debug information.
</p>
<p>
- Debug info can be rendered on main page or as separate popup window.
+ Debug info can be rendered on the main page or as a separate popup window.
</p>
Modified: trunk/samples/richfaces-demo/src/main/webapp/richfaces/messages/usage.xhtml
===================================================================
--- trunk/samples/richfaces-demo/src/main/webapp/richfaces/messages/usage.xhtml 2007-09-05
13:55:36 UTC (rev 2766)
+++ trunk/samples/richfaces-demo/src/main/webapp/richfaces/messages/usage.xhtml 2007-09-05
14:01:07 UTC (rev 2767)
@@ -18,10 +18,10 @@
<li>has a predefined css class names for different kinds of messages
severities</li>
</ul>
</p>
- <p>The message markers is defined with a facets. There are several facets names
available
+ <p>The message markers is defined with facets. There are several facets names
available
to design the marker for different kind of messages severities. The following example
shows how the markers might be used to mark the "passed" and
"failed" form fields.
- Fill the form and click "Validate" button to see the entered data passing
the
+ Fill the form and click the "Validate" button to see the entered data
passing the
defined validation rules.
</p>
<div class="sample-container" >
Modified: trunk/samples/richfaces-demo/src/main/webapp/richfaces/outputPanel/usage.xhtml
===================================================================
---
trunk/samples/richfaces-demo/src/main/webapp/richfaces/outputPanel/usage.xhtml 2007-09-05
13:55:36 UTC (rev 2766)
+++
trunk/samples/richfaces-demo/src/main/webapp/richfaces/outputPanel/usage.xhtml 2007-09-05
14:01:07 UTC (rev 2767)
@@ -12,26 +12,26 @@
<p><code>a4j:outputPanel</code> is rendered as a
<span> html element if the
<code>'layout'</code> attribute is equal
<code>'inline'</code>
(default value) or as a <div> html element if
<code>layout="block"</code>.
- You can use this component for a layout purpose even the page has no Ajax
functionality.
+ You can use this component for a layout purpose even if the page has no Ajax
functionality.
</p>
- <p>In case of Ajax functionality presents on the page, the component offects two
additional
+ <p>If Ajax functionality presents on the page, the component offers two
additional
features:
<ul>
<li>Marking the area of the page as automatically re-rendered on each Ajax
request event
- without a nessesity necessity to mentioned this area in the
<code>reRender</code> attribute of Ajax
- component. Attribute <code>ajaxRendered="true"</code> turn on
this future. Note, that the effect of using
- ajaxRendered="true" still might be overrided with limitToList attribute of
the Ajax component
+ without any necessity to mentioned this area in the <code>reRender</code>
attribute of Ajax
+ component. Attribute <code>ajaxRendered="true"</code> turn on
this feature. Note, that the effect of using
+ ajaxRendered="true" still might be overridden with the limitToList
attribute of the Ajax component
or <code>renderRegionOnly</code> attribute of the
<code>a4j:region</code> component.</li>
<li>Marking the placeholder for any JSF component in case of it is not rendered
due to
<code>rendered="false"</code>. This might be important when the
component becomes rendered during the next
- Ajax response. As soon as the placeholder is unknown, the rendered component will not
appear
- appear on the page. To turn on the feature of marking the placeholder you need to have
the
+ Ajax response. As soon as the placeholder is unknown, the rendered component
doesn't
+ appear on a page. To turn on the feature for marking the placeholder, you need to have
the
attribute <code>layout="none"</code>.</li>
</ul>
</p>
<p>When <code>layout="none"</code>, the span
<code>style="display:none"</code> is
- rendered and assign the id of the child component if the component is not rendered.
- Otherwize, it does not rendered at all.<br/>
+ rendered and assigns the id of the child component if the component is not rendered.
+ Otherwise, it does not become rendered at all.<br/>
The following example shows the cases of usage described above:</p>
<div class="sample-container" >