test extension point documentation

This commit is contained in:
Heng Sin Low 2010-12-19 12:31:26 +08:00
parent 8f05481aed
commit b705537692
3 changed files with 255 additions and 0 deletions

View File

@ -0,0 +1,72 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- saved from url=(0135)file:///tmp/1042236961/eclipse/.update/1292567746703/1292567746704/pde_schema_org-adempiere-webui-org-adempiere-webui-Form_preview.html -->
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Web Form</title>
<style type="text/css">@import url("css/book.css");</style>
<style type="text/css">@import url("css/schema.css");</style>
</head>
<body>
<h1 style="text-align:center">Web Form</h1>
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>org.adempiere.webui.org.adempiere.webui.Form<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Since: </h6>1.0.0
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Description: </h6>Extension point to provide form controller implementation. Use the {extension id} in AD_Form.ClassName to reference the extension that will provide the form controller instance ( replace {extension id} with your actual extension id ). Note that if you intend to support both swing and zk client, you should use the same extension id for the swing and zk form extension ( of course, class name should be different ).<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Configuration Markup:</h6>
<p></p>
<p class="code SchemaDtd">&lt;!ELEMENT <a name="e.extension">extension</a> (<a href="#e.form">form</a>)&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST extension</p>
<p class="code SchemaDtdAttlist">point&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">name&nbsp;&nbsp;CDATA #IMPLIED</p>&gt;<p></p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.form">form</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST form</p>
<p class="code SchemaDtdAttlist">class&nbsp;CDATA #REQUIRED</p>&gt;<p></p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>class</b> - Implementation class name for the org.adempiere.webui.panel.IFormController interface</li>
</ul>
<br><h6 class="CaptionFigColumn SchemaHeader">Examples: </h6><pre class="Example"><span class="code SchemaTag">
&lt;extension
id=</span><span class="code SchemaCstring">"org.adempiere.extend.myForm"</span><span class="code SchemaTag">
name=</span><span class="code SchemaCstring">"My Form"</span><span class="code SchemaTag">
point=</span><span class="code SchemaCstring">"org.adempiere.webui.Form"</span><span class="code SchemaTag">&gt;
&lt;process
class=</span><span class="code SchemaCstring">"org.adempiere.ui.zk.extend.MyForm"</span><span class="code SchemaTag">&gt;
&lt;/process&gt;
&lt;/extension&gt;
AD_Form.ClassName="org.adempiere.extend.myForm"
</span></pre>
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">API Information: </h6>The class attribute must represent an implementor of org.adempiere.webui.panel.IFormController
<p></p>
<br>
<p class="note SchemaCopyright">
This file is part of Adempiere ERP Bazaar
http://www.adempiere.org
Copyright (C) Heng Sin Low
Copyright (C) Contributors
This program is free software; you can redistribute it and/or modify it
under the terms version 2 of the GNU General Public License as published
by the Free Software Foundation. This program is distributed in the hope
that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
Contributors:
</p>
</body></html>

112
doc/extension/css/book.css Normal file
View File

@ -0,0 +1,112 @@
P.Code {
display: block;
text-align: left;
text-indent: 0.00pt;
margin-top: 0.000000pt;
margin-bottom: 0.000000pt;
margin-right: 0.000000pt;
margin-left: 15pt;
font-size: 10.000000pt;
font-weight: normal;
font-style: normal;
color: #4444CC;
text-decoration: none;
vertical-align: baseline;
text-transform: none;
font-family: "Courier New", Courier, monospace;
}
H6.CaptionFigColumn {
display: block;
text-align: left;
text-indent: 0.000000pt;
margin-top: 3.000000pt;
margin-bottom: 11.000000pt;
margin-right: 0.000000pt;
margin-left: 0.000000pt;
font-size: 9.000000pt;
font-weight: bold;
font-style: Italic;
color: #000000;
text-decoration: none;
vertical-align: baseline;
text-transform: none;
}
P.Note {
display: block;
text-align: left;
text-indent: 0pt;
margin-top: 19.500000pt;
margin-bottom: 19.500000pt;
margin-right: 0.000000pt;
margin-left: 30pt;
font-size: 11.000000pt;
font-weight: normal;
font-style: Italic;
color: #000000;
text-decoration: none;
vertical-align: baseline;
text-transform: none;
}
EM.UILabel {
font-weight: Bold;
font-style: normal;
text-decoration: none;
vertical-align: baseline;
text-transform: none;
}
EM.CodeName {
font-weight: Bold;
font-style: normal;
text-decoration: none;
vertical-align: baseline;
text-transform: none;
font-family: "Courier New", Courier, monospace;
}
body, html { border: 0px }
/* following font face declarations need to be removed for DBCS */
body, h1, h2, h3, h4, h5, h6, p, table, td, caption, th, ul, ol, dl, li, dd, dt {font-family: Arial, Helvetica, sans-serif; color: #000000}
pre { font-family: "Courier New", Courier, monospace;}
/* end font face declarations */
/* following font size declarations should be OK for DBCS */
body, h1, h2, h3, h4, h5, h6, p, table, td, caption, th, ul, ol, dl, li, dd, dt {font-size: 10pt; }
pre { font-size: 10pt}
/* end font size declarations */
body { background: #FFFFFF; margin-bottom: 1em }
h1 { font-size: 18pt; margin-top: 5; margin-bottom: 1 }
h2 { font-size: 14pt; margin-top: 25; margin-bottom: 3 }
h3 { font-size: 11pt; margin-top: 20; margin-bottom: 3 }
h4 { font-size: 10pt; margin-top: 20; margin-bottom: 3; font-style: italic }
p { margin-top: 10px; margin-bottom: 10px }
pre { margin-left: 6; font-size: 9pt; color: #4444CC }
a:link { color: #0000FF }
a:hover { color: #000080 }
a:visited { text-decoration: underline }
ul { margin-top: 10px; margin-bottom: 10px; }
li { margin-top: 5px; margin-bottom: 5px; }
li p { margin-top: 5px; margin-bottom: 5px; }
ol { margin-top: 10px; margin-bottom: 10px; }
dl { margin-top: 10px; margin-bottom: 10px; }
dt { margin-top: 5px; margin-bottom: 5px; font-weight: bold; }
dd { margin-top: 5px; margin-bottom: 5px; }
strong { font-weight: bold}
em { font-style: italic}
var { font-style: italic}
div.revision { border-left-style: solid; border-left-width: thin;
border-left-color: #7B68EE; padding-left:5 }
th { font-weight: bold }
a.command-link {
}
a.command-link img {
border-width: 0px;
border-style: none;
vertical-align: middle;
}

View File

@ -0,0 +1,71 @@
/*******************************************************************************
* Copyright (c) 2003 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
H6.SchemaHeader {
font-size:16px;
display:inline
}
P.SchemaCopyright {
font-size: smaller;
font-style: normal;
color: #336699;
display:inline;
margin-top: 3.000000pt;
margin-bottom: 11.000000pt;
margin-right: 0.000000pt;
margin-left: 0.000000pt;
}
P.SchemaDtd {
color: #800000;
margin-top: 0.000000pt;
margin-bottom: 0.000000pt;
margin-right: 0.000000pt;
margin-left: 10.000000pt;
}
P.SchemaDtdAttlist {
color: #800000;
margin-top: 0.000000pt;
margin-bottom: 0.000000pt;
margin-right: 0.000000pt;
margin-left: 20.000000pt;
}
span.SchemaTag {
color: #000080;
}
span.SchemaCstring {
color: #008000;
}
pre.Example {
margin-top: 0.000000pt;
}
.ConfigMarkupElementDesc {
color: black;
margin-top: 0.000000pt;
margin-bottom: 0.000000pt;
margin-right: 0.000000pt;
margin-left: 10.000000pt;
}
.ConfigMarkupAttlistDesc {
color: black;
margin-top: 0.000000pt;
margin-bottom: 0.000000pt;
margin-right: 0.000000pt;
margin-left: 32.000000pt;
}