| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <HTML> |
| <HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| <title>Overview Page</title> |
| <style>@import url("../../book.css");</style> |
| <style>@import url("../../schema.css");</style> |
| </HEAD> |
| <BODY> |
| <H1><CENTER>Overview Page</CENTER></H1> |
| <p></p> |
| <h6 class=CaptionFigColumn id=header>Identifier: </h6>com.sybase.stf.jmt.common.overviewPage<p></p> |
| <h6 class=CaptionFigColumn id=header>Since: </h6>1.0.0 |
| <p></p> |
| |
| <p> |
| <h6 class=CaptionFigColumn id=header>Description: </h6>The purpose of this extension point is to allow plug-ins to describe the contents and links on a overview page of an editor.</p> |
| <p><h6 class=CaptionFigColumn id=header>Configuration Markup:</h6></p> |
| <p class=code id=dtd><!ELEMENT <a name="e.extension">extension</a> (<a href="#e.overviewpage">overviewpage</a>)></p> |
| <p class=code id=dtd><!ATTLIST extension</p> |
| <p class=code id=dtdAttlist>point CDATA #REQUIRED<p class=code id=dtdAttlist>id CDATA #REQUIRED<p class=code id=dtdAttlist>name CDATA #IMPLIED></p> |
| <p></p> |
| <ul class=ConfigMarkup id=attlistDesc> |
| <li><b>point</b> - a fully qualified identifier of the target extension point.</li> |
| <li><b>id</b> - identifier of the extension instance, this should be the same as the editor id.</li> |
| <li><b>name</b> - an optional name of the extension instance. Normally this is the editor name.</li> |
| </ul> |
| <br><p class=code id=dtd><!ELEMENT <a name="e.overviewpage">overviewpage</a> (<a href="#e.overviewelement">overviewelement</a>+)></p> |
| <p class=code id=dtd><!ATTLIST overviewpage</p> |
| <p class=code id=dtdAttlist>name CDATA #REQUIRED<p class=code id=dtdAttlist>description CDATA #IMPLIED></p> |
| <p></p> |
| <p class=ConfigMarkup id=elementDesc> |
| The details for an overview page for a specific plugins editor</p> |
| <br> |
| <ul class=ConfigMarkup id=attlistDesc> |
| <li><b>name</b> - The name of the page.</li> |
| <li><b>description</b> - A description for the page.</li> |
| </ul> |
| <br><p class=code id=dtd><!ELEMENT <a name="e.overviewelement">overviewelement</a> EMPTY></p> |
| <p class=code id=dtd><!ATTLIST overviewelement</p> |
| <p class=code id=dtdAttlist>icon CDATA #IMPLIED<p class=code id=dtdAttlist>heading CDATA #IMPLIED<p class=code id=dtdAttlist>text CDATA #IMPLIED<p class=code id=dtdAttlist>hyperlink CDATA #IMPLIED<p class=code id=dtdAttlist>hyperlinkaction CDATA #IMPLIED<p class=code id=dtdAttlist>actionparameters CDATA #IMPLIED></p> |
| <p></p> |
| <p class=ConfigMarkup id=elementDesc> |
| An element that make up a section of the page. Elements can contain Headers, Hyperlinks, Icons and text.</p> |
| <br> |
| <ul class=ConfigMarkup id=attlistDesc> |
| <li><b>icon</b> - An icon to display in the element. The icon should be 72x72 and will appear to the left of the headers, hyperlinks and text</li> |
| <li><b>heading</b> - A short heading for the element (optional)</li> |
| <li><b>text</b> - The text description for the element</li> |
| <li><b>hyperlink</b> - A hyperlink associated with the element. The hyperlink would normally execute the hyperlinkaction action</li> |
| <li><b>hyperlinkaction</b> - The action associated with the hyperlink. This is an action that will be executed when the hyperlink is selected</li> |
| <li><b>actionparameters</b> - Can be used to pass one or more parameters to the hyperlink action. Parameter must be space separated (optional)</li> |
| </ul> |
| <br><h6 class=CaptionFigColumn id=header>Examples: </h6><extension |
| id="com.sybase.stf.jmt.editors.pageflow.PageflowEditor" |
| name="%pageflow.editor.intro.name" |
| point="com.sybase.stf.jmt.editors.pageflow.overviewPage"> |
| <overviewpage |
| name="%pageflow.editor.intro.name" |
| description="%port.editor.intro.description"> |
| <overviewelement |
| icon="icons/pageflow_72.gif" |
| heading="%pageflow.editor.intro.heading" |
| text="%pageflow.editor.intro.description"> |
| </overviewelement> |
| <overviewelement |
| actionparameters="Pageflow.designerCheatSheet" |
| icon="icons/tutorials_72.gif" |
| hyperlinkaction="com.sybase.stf.jmt.actions.LoadCheatSheetAction" |
| text="%pageflow.editor.intro.cheatsheets.text" |
| hyperlink="%pageflow.editor.intro.cheatsheets.link"> |
| </overviewelement> |
| <overviewelement |
| actionparameters="http://www.sybase.com/products" |
| icon="icons/overview_72.gif" |
| hyperlinkaction="com.sybase.stf.jmt.actions.LoadHelpAction" |
| text="%pageflow.editor.intro.help.text" |
| hyperlink="%pageflow.editor.intro.help.link"> |
| </overviewelement> |
| <overviewelement |
| actionparameters="overview" |
| icon="icons/gotoeditor_72.gif" |
| hyperlinkaction="com.sybase.stf.jmt.actions.OpenPageAction" |
| text="%pageflow.editor.intro.start.text" |
| hyperlink="%pageflow.editor.intro.start.link"> |
| </overviewelement> |
| </overviewpage> |
| </extension> |
| <p></p> |
| |
| <br> |
| <p class=note id=copyright> |
| Copyright (c) Sybase, Inc. 2004 <br> |
| All rights reserved. |
| <p></p> |
| |
| </p> |
| </BODY> |
| </HTML> |
