Author: buildbot
Date: Fri Nov 14 13:48:44 2014
New Revision: 929173
Log:
Staging update by buildbot for isis
Modified:
websites/staging/isis/trunk/cgi-bin/ (props changed)
websites/staging/isis/trunk/content/ (props changed)
websites/staging/isis/trunk/content/how-tos/how-to-01-040-How-to-specify-a-title-for-a-domain-entity.html
websites/staging/isis/trunk/content/how-tos/how-to-01-070-How-to-specify-the-icon-for-a-domain-entity.html
websites/staging/isis/trunk/content/intro/learning-more/articles-and-presentations.html
Propchange: websites/staging/isis/trunk/cgi-bin/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Fri Nov 14 13:48:44 2014
@@ -1 +1 @@
-1634821
+1639635
Propchange: websites/staging/isis/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Fri Nov 14 13:48:44 2014
@@ -1 +1 @@
-1634821
+1639635
Modified:
websites/staging/isis/trunk/content/how-tos/how-to-01-040-How-to-specify-a-title-for-a-domain-entity.html
==============================================================================
---
websites/staging/isis/trunk/content/how-tos/how-to-01-040-How-to-specify-a-title-for-a-domain-entity.html
(original)
+++
websites/staging/isis/trunk/content/how-tos/how-to-01-040-How-to-specify-a-title-for-a-domain-entity.html
Fri Nov 14 13:48:44 2014
@@ -425,43 +425,32 @@
<h2>How to specify a title for a domain entity</h2>
-<p>A title is used to identify an object to the user in the user interface.
-For example, a Customer's title might be the organization's customer
-reference, or perhaps (more informally) their first and last names.</p>
-
-<p>By default, the framework will use the object's <code>toString()</code>
method as
-the title. Most titles tend to be made up of the same set of elements:
-for example a Customer's name might be the concatenation of their
-customer first name and their ;ast name. For these the @Title annotation
-can be used:</p>
+<p>Apache Isis viewers identify objects through both an <a
href="./how-to-01-070-How-to-specify-the-icon-for-a-domain-entity.html">icon</a>
+and a title. For example, a <code>Customer</code>'s title might be the
organization's customer reference, or perhaps (more
+informally) their first and last names.</p>
-<pre><code>public class Customer {
- @Title
- public String getFirstName() { ... }
- @Title
- public String getLastName() { ... }
- ...
-}
-</code></pre>
+<p>The framework has a number of ways to determine the title. </p>
-<p>For more control, the order of the title components can be specified
-using a sequence number (specified in Dewey decimal format):</p>
+<h2>Declarative</h2>
+
+<p>Most titles tend to be made up of the same set of elements. For example a
<code>Customer</code>'s name might be the concatenation
+of their first name and their last name. For these the <code>@Title</code>
annotation can be used:</p>
<pre><code>public class Customer {
- @Title("1.0")
+ @Title(sequence="2")
public String getFirstName() { ... }
- @Title("1.1")
+ @Title(sequence="1", append=",")
public String getLastName() { ... }
...
}
</code></pre>
-<p>For more control the title can be declared imperately using the
-<code>title()</code> method (returning a <code>String</code>). This leaves the
programmer
-needs to make use of the <code>toString()</code> method for other purposes,
such as
-for debugging. For example, to return the title for a customer which is
-their last name and then first initial of their first name, we could
-use:</p>
+<p>For each property that is part of the title joining strings can be
specified to <code>prepend</code> or <code>append</code> the property value.</p>
+
+<h2>Imperative</h2>
+
+<p>For more control the title can be declared imperately using the
<code>title()</code> method (returning a <code>String</code>). For example,
+to return the title for a customer which is their last name and then first
initial of their first name, we could write:</p>
<pre><code>public class Customer {
public String title() {
@@ -471,9 +460,15 @@ use:</p>
}
</code></pre>
-<p>The applib contains a class,
<code>org.apache.isis.applib.util.TitleBuffer</code>,
-which you can use to help create title strings if you so wish. <!-- See ? for
-more details.--></p>
+<p>The <code>org.apache.isis.applib.util.TitleBuffer</code> utility class can
be used to create title strings if you so wish.</p>
+
+<h2>Fallback</h2>
+
+<p>If there is no <code>title()</code> method and no properties annotated with
<code>@Title</code>, then the object's <code>toString()</code> method is
+used instead.</p>
+
+<p>In general though we recommend that you do provide either a title
explicitly. You can then use <code>toString()</code> method for
+other purposes, such as debugging. </p>
Modified:
websites/staging/isis/trunk/content/how-tos/how-to-01-070-How-to-specify-the-icon-for-a-domain-entity.html
==============================================================================
---
websites/staging/isis/trunk/content/how-tos/how-to-01-070-How-to-specify-the-icon-for-a-domain-entity.html
(original)
+++
websites/staging/isis/trunk/content/how-tos/how-to-01-070-How-to-specify-the-icon-for-a-domain-entity.html
Fri Nov 14 13:48:44 2014
@@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
- <title></title>
+ <title>How to specify the icon for a domain object
</title>
<meta name="description" content="">
<meta name="author" content="">
@@ -294,7 +294,7 @@
};
function twshare () {
window.open(
-
"https://twitter.com/intent/tweet?url="+document.URL+"&text=";,
+
"https://twitter.com/intent/tweet?url="+document.URL+"&text=How to specify the
icon for a domain object
",
'Share on Twitter',
'width=800,height=526');
};
@@ -418,14 +418,41 @@
<div class="page-header">
<p><a href="./../documentation.html">Docs</a> » <a
href="./../how-tos/about.html">How Tos</a></p>
-<h1>
+<h1>How to specify the icon for a domain object
</h1>
</div>
-<h2>How to specify the icon for a domain entity</h2>
+<p>Apache Isis viewers identify objects through both an icon and a <a
href="./how-to-01-040-How-to-specify-a-title-for-a-domain-entity.html">title</a>.</p>
-<p>By default, the framework will look for an image in the <code>images</code>
+<p>The icon can be either static and fixed - meaning it is based on the
object's class - or dynamic and changing - meaning
+it can change according to the object's state. For example, an
<code>Order</code> could indicate its status (pending, shipped), or a
<code>ToDoItem</code> could indicate if it is complete or not.</p>
+
+<p>The mechanism to locate up the icon is viewer-specific. In the <a
href="../components/viewers/wicket/about.html">Wicket viewer</a> there are two
mechanisms for locating an icon/image, though one applies only to static
icons.</p>
+
+<p>If the icon is static then it is located either:</p>
+
+<ul>
+<li>(1.8.0-SNAPSHOT onwards) by specifying a <a
href="http://fortawesome.github.io/Font-Awesome/";>font awesome</a> icon
+for the class using either the <a
href="../reference/recognized-annotations/CssClassFa.html"><code>@CssClassFa</code></a>
annotation, or
+an equivalent entry in the <a
href="../components/viewers/wicket/dynamic-layouts.html">.layout.json</a>
file.</li>
+<li>else, provide an image file for the class, eg <code>ToDoItem.png</code>,
picked up from a well-known location on the
+classpath.</li>
+</ul>
+
+<p>If the icon is dynamic then it is located by the second mechanism only,
that is:</p>
+
+<ul>
+<li>provide an image file for the object, eg
<code>ToDoItem-completed.png</code>, again picked up from a well-known location
on
+the classpath.</li>
+</ul>
+
+<p>The sections below explain this in more detail.</p>
+
+<h2>Statically specified 'font awesome' icon</h2>
+
+<p>The framework has a number of mechanisms to locate the image.
+By default, the framework will look for an image in the <code>images</code>
directory (either from the classpath or from the filesystem) that has
the same name as the object class. Multiple file extensions are searched
for, including <code>.png</code>, <code>.gif</code> and <code>.jpg</code> (in
order of preference). For
@@ -447,6 +474,10 @@ icon <code>OrderLine.png</code>. Actuall
are case sensitive, so it is good practice to adopt an unambiguous
convention.</p>
+<h2>Statically-specified image file</h2>
+
+<h2>Dynamically-specified image file</h2>
+
<p>Alternatively, you can use the <code>iconName</code>() method instead:</p>
<pre><code>public String iconName() {
Modified:
websites/staging/isis/trunk/content/intro/learning-more/articles-and-presentations.html
==============================================================================
---
websites/staging/isis/trunk/content/intro/learning-more/articles-and-presentations.html
(original)
+++
websites/staging/isis/trunk/content/intro/learning-more/articles-and-presentations.html
Fri Nov 14 13:48:44 2014
@@ -427,9 +427,10 @@
<p>2014</p>
-<ul>
-<li>Presentation, JEEConf: <a
href="https://www.youtube.com/watch?v=BNGUqZ6YE-M";>Extremely rapid application
development with Apache Isis</a> (50 min. video)</li>
-</ul>
+<p><!--
+* Presentation, BDD Exchange: <a href="xxx">To those whom much is given, much
is expected... </a> (45 min. video)
+-->
+* Presentation, JEEConf: <a
href="https://www.youtube.com/watch?v=BNGUqZ6YE-M";>Extremely rapid application
development with Apache Isis</a> (50 min. video)</p>
<p>2013</p>
