Overview Page
Identifier:
org.eclipse.jst.jsf.facesconfig.common.overviewPage
Since:
1.0.0
Description:
The purpose of this extension point is to allow plug-ins to describe the contents and links on a overview page of an editor.
Configuration Markup:
<!ELEMENT extension (overviewpage)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #REQUIRED
name CDATA #IMPLIED>
- point - a fully qualified identifier of the target extension point.
- id - identifier of the extension instance, this should be the same as the editor id.
- name - an optional name of the extension instance. Normally this is the editor name.
<!ELEMENT overviewpage (overviewelement+)>
<!ATTLIST overviewpage
name CDATA #REQUIRED
description CDATA #IMPLIED>
The details for an overview page for a specific plugins editor
- name - The name of the page.
- description - A description for the page.
<!ELEMENT overviewelement EMPTY>
<!ATTLIST overviewelement
icon CDATA #IMPLIED
heading CDATA #IMPLIED
text CDATA #IMPLIED
hyperlink CDATA #IMPLIED
hyperlinkaction CDATA #IMPLIED
actionparameters CDATA #IMPLIED>
An element that make up a section of the page. Elements can contain Headers, Hyperlinks, Icons and text.
- icon - An icon to display in the element. The icon should be 72x72 and will appear to the left of the headers, hyperlinks and text
- heading - A short heading for the element (optional)
- text - The text description for the element
- hyperlink - A hyperlink associated with the element. The hyperlink would normally execute the hyperlinkaction action
- hyperlinkaction - The action associated with the hyperlink. This is an action that will be executed when the hyperlink is selected
- actionparameters - Can be used to pass one or more parameters to the hyperlink action. Parameter must be space separated (optional)
Examples:
Copyright (c) 2004, 2006 Sybase, Inc. 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:
Sybase, Inc. - initial API and implementation