| <!doctype html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8"> |
| <!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]--> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| <meta name="generator" content="Asciidoctor 1.5.5"> |
| <title>New Page Wizard</title> |
| <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"> |
| <link rel="stylesheet" href="css/eclipse.css"> |
| <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.6.3/css/font-awesome.min.css"> |
| <link rel="stylesheet" href="css/coderay-eclipse.css"> |
| </head> |
| <body class="article"> |
| <table border="0" class="navigation" style="width: 100%;" summary="navigation"> |
| <tr> |
| <td align="left" colspan="1" rowspan="1" style="width: 30%"><a href="sdk_wizard_form.html" shape="rect" title="New Form Wizard"><img alt="Previous" border="0" src="images/prev.gif"></a></td> |
| <td align="center" colspan="1" rowspan="1" style="width: 40%"></td> |
| <td align="right" colspan="1" rowspan="1" style="width: 30%"><a href="sdk_wizard_nls-entry.html" shape="rect" title="NLS Entry Wizard"><img alt="Next" border="0" src="images/next.gif"></a></td> |
| </tr> |
| <tr> |
| <td align="left" colspan="1" rowspan="1" style="width: 30%">New Form Wizard</td> |
| <td align="center" colspan="1" rowspan="1" style="width: 40%"></td> |
| <td align="right" colspan="1" rowspan="1" style="width: 30%">NLS Entry Wizard</td> |
| </tr> |
| </table> |
| <div id="header"> |
| </div> |
| <div id="content"> |
| <div class="sect3"> |
| <h4 id="new-page-wizard"><a class="anchor" href="#new-page-wizard"></a>New Page Wizard</h4> |
| <div class="paragraph"> |
| <p>The <em>New Scout Page</em> wizard can be used to create a new page and related classes. To start the wizard use <span class="menuseq"><span class="menu">File</span> ▸ <span class="submenu">New</span> ▸ <span class="menuitem">Other…​</span></span> or press <span class="keyseq"><kbd>Ctrl</kbd>+<kbd>N</kbd></span>.</p> |
| </div> |
| <div id="img-sdk_wizard_page" class="imageblock"> |
| <div class="content"> |
| <img src="images/sdk_new_page.png" alt="sdk new page"> |
| </div> |
| <div class="title"> |
| Figure 1. The new Page Wizard |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>In the case of <a href="#img-sdk_wizard_page">Figure 1</a> the package <code>org.eclipse.scout.apps.helloworld.client.helloworld</code> has been selected in the Package Explorer. The only wizard field that then needs to be filled in manually is the <strong>Name</strong> field.</p> |
| </div> |
| <div class="paragraph"> |
| <p>By clicking on the <b class="button">Finish</b> button the wizard is started and the specified components are created.</p> |
| </div> |
| <div class="sect4"> |
| <h5 id="wizard-fields-and-default-values"><a class="anchor" href="#wizard-fields-and-default-values"></a>Wizard Fields and Default Values</h5> |
| <div class="paragraph"> |
| <p>Most of the fields of the <a href="#img-sdk_wizard_page">Figure 1</a> will be filled with default values depending on the current context of the IDE. The context can be derived from a package selected in the Package Explorer or from the class in the active Java Editor.</p> |
| </div> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1"> |
| Source Folder |
| </dt> |
| <dd> |
| <p>The source folder of the Maven client module used for the creation of the page. The default value is the <code>src/main/java</code> folder in the Maven client module.</p> |
| </dd> |
| <dt class="hdlist1"> |
| Package |
| </dt> |
| <dd> |
| <p>The Java package that will contain the page class. The Scout SDK will try to guess the package name from the current context and derive matching package names for the Maven shared module.</p> |
| </dd> |
| <dt class="hdlist1"> |
| Name |
| </dt> |
| <dd> |
| <p>The name of the page class. According to Scout conventions the class name ends with the suffix <code>TablePage</code> (for subclasses of <code>AbstractPageWithTable</code>) or <code>NodePage</code> (for <code>AbstractPageWithNodes</code>).</p> |
| </dd> |
| <dt class="hdlist1"> |
| Super Class |
| </dt> |
| <dd> |
| <p>The super class for the form. <code>AbstractPageWithTable</code> is the default value.</p> |
| </dd> |
| <dt class="hdlist1"> |
| Shared Source Folder |
| </dt> |
| <dd> |
| <p>The source folder of the Maven shared module used for creation of the page data and the service interface. The default value is the <code>src/main/java</code> folder in the Maven shared module.</p> |
| </dd> |
| <dt class="hdlist1"> |
| Server Source Folder |
| </dt> |
| <dd> |
| <p>The source folder of the Maven server module used for creation of the service implementation. The default value is the <code>src/main/java</code> folder in the Maven server module.</p> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <div class="sect4"> |
| <h5 id="created-components"><a class="anchor" href="#created-components"></a>Created Components</h5> |
| <div class="paragraph"> |
| <p>In the <a href="#img-sdk_wizard_page">Figure 1</a> example shown above the Scout SDK will create the following components.</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> <p>In Maven module <strong>helloworld.client</strong></p> |
| <div class="ulist"> |
| <ul> |
| <li> <p>The <code>MyTablePage</code> page class in folder <code>src/main/java</code> and package <code>org.eclipse.scout.apps.helloworld.client.helloworld</code></p> </li> |
| </ul> |
| </div> </li> |
| <li> <p>In Maven module <strong>helloworld.shared</strong></p> |
| <div class="ulist"> |
| <ul> |
| <li> <p>The <code>IMyService</code> service interface in folder <code>src/main/java</code> and package <code>org.eclipse.scout.apps.helloworld.shared.helloworld</code></p> </li> |
| <li> <p><code>MyTablePageData</code> page data class in folder <code>src/generated/java</code> and package <code>org.eclipse.scout.apps.helloworld.shared.helloworld</code></p> </li> |
| </ul> |
| </div> </li> |
| <li> <p>In Maven module <strong>helloworld.server</strong></p> |
| <div class="ulist"> |
| <ul> |
| <li> <p>The <code>MyService</code> implementation in folder <code>src/main/java</code> and package <code>org.eclipse.scout.apps.helloworld.server.helloworld</code></p> </li> |
| </ul> |
| </div> </li> |
| </ul> |
| </div> |
| <hr> |
| <div class="paragraph"> |
| <p>Go back to the <a href="sdk_wizard.html">Scout Wizards</a>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Do you want to improve this document? Have a look at the <a href="https://github.com/BSI-Business-Systems-Integration-AG/org.eclipse.scout.docs/blob/releases/7.0.x/docs/build/eclipse_help/src/docs/sdk_wizard_page.adoc" target="_blank">sources</a> on GitHub.</p> |
| </div> |
| </div> |
| </div> |
| </div> |
| <table border="0" class="navigation" style="width: 100%;" summary="navigation"> |
| <tr> |
| <td align="left" colspan="1" rowspan="1" style="width: 30%"><a href="sdk_wizard_form.html" shape="rect" title="New Form Wizard"><img alt="Previous" border="0" src="images/prev.gif"></a></td> |
| <td align="center" colspan="1" rowspan="1" style="width: 40%"><a href="scout_user_guide.html" shape="rect" title="Eclipse Scout User Guide"><img alt="Eclipse Scout User Guide" border="0" src="images/home.gif"></a></td> |
| <td align="right" colspan="1" rowspan="1" style="width: 30%"><a href="sdk_wizard_nls-entry.html" shape="rect" title="NLS Entry Wizard"><img alt="Next" border="0" src="images/next.gif"></a></td> |
| </tr> |
| <tr> |
| <td align="left" colspan="1" rowspan="1" style="width: 30%">New Form Wizard</td> |
| <td align="center" colspan="1" rowspan="1" style="width: 40%"></td> |
| <td align="right" colspan="1" rowspan="1" style="width: 30%">NLS Entry Wizard</td> |
| </tr> |
| </table> |
| <div id="footer"> |
| <div id="footer-text"> |
| Version 7.0 |
| <br> Last updated 2017-05-26 14:49:24 CEST |
| </div> |
| </div> |
| </body> |
| </html> |
