Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "RAP Theme Editor"
(→Source Tab) |
(→Prospective Features) |
||
| (6 intermediate revisions by the same user not shown) | |||
| Line 21: | Line 21: | ||
</div> | </div> | ||
| − | + | [[Image:Ok_green.gif]] Multipage Editor with 3 tabs (widgets tab, rules tab, source tab) for editing all parts of a RAP theme file | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | * source editor, so that theme files can be edited by hand as well [[Image:Ok_green.gif]] | + | [[Image:Ok_green.gif]] loading supported widgets and their possible properties dynamically through the *.theme.xml files associated with each RAP widget |
| − | + | ||
| − | + | [[Image:Ok_green.gif]] synchronization between GUI-tabs and source tab | |
| − | + | ||
| − | + | [[Image:Ok_green.gif]] dialogs that handle input of certain property types, e.g. ColorDialog, FontDialog, FileDialog | |
| − | + | ||
| + | [[Image:Ok_green.gif]] Redo/Undo functionality | ||
| + | |||
| + | [[Image:Ok_green.gif]] source editor, so that theme files can be edited by hand as well | ||
| + | |||
| + | [[Image:Ok_green.gif]] Problem Marker in source tab | ||
| + | |||
| + | [[Image:Ok_green.gif]] syntax coloring in source tab | ||
| + | |||
| + | [[Image:Ok_green.gif]] contribution to standard Outline view | ||
| + | |||
| + | [[Image:Ok_green.gif]] content assist in source editor | ||
| + | |||
| + | [[Image:Ok_green.gif]] text hover in source editor | ||
== Widgets Tab == | == Widgets Tab == | ||
| + | The widgets tab contains a "widget tree" with all supported RAP widgets. All possible properties can be set for the currently selected widget. | ||
| + | |||
| + | Using the widgets tab prevents the user from thinking about the structure of a theme file, including its inheritance. So the user can just set the properties for a desired widget. | ||
== Rules Tab == | == Rules Tab == | ||
| + | A list of all rules contained in a theme file is shown in the rules tab. The selector list of each rule can be altered by adding selectors or removing applied ones. Moreover the content of a rule can be changed in a way of adding, removing or editing properties according to the desired rule. | ||
== Source Tab == | == Source Tab == | ||
| Line 48: | Line 61: | ||
== Prospective Features == | == Prospective Features == | ||
| − | + | [[Image:Glass.gif]] preview for all widgets in order to see directly an visual impact when changing a property | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | [[Image:Glass.gif]] ability to register custom widgets in order to style them as well | |
| − | + | [[Image:Glass.gif]] element hierarchy in *.theme.xml files: This xml structure should correspond with the one in the widget tree in widget tab. | |
| − | + | [[Image:Glass.gif]] Button, which will start the RAP application instantly with the currently opened theme file | |
| − | + | [[Image:Glass.gif]] preference page for editor wide settings: e.g. syntax coloring, settings for content assist, widget preview, ... | |
| − | + | [[Image:Glass.gif]] after some "refine" actions the theme file could be cluttered and unclear to read: so provide a feature that will clean up the theme file by removing unused rules or properties and merge rules with same selector list if possible | |
== Getting the Source == | == Getting the Source == | ||
Latest revision as of 13:34, 21 August 2008
Contents
Abstract
The goal of this project is to provide an Eclipse Plug-In that handles RAP theme files. At the moment RAP theme files have to be edited in a normal text editor. That is fault-prone and definitely not userfriendly. So beside syntax checking the Theme Editor will provide a graphical user interface to change several properties and values for RAP themes in an easier way.
This project is part of 2008 Google Summer of Code.
Participants:
- Mentor: Ralf Sternberg
- Student: Mathias Schaeffner
Features
Legend
Needs some investigation/research
Work in progress
Bug fixed / Feature added
Multipage Editor with 3 tabs (widgets tab, rules tab, source tab) for editing all parts of a RAP theme file
loading supported widgets and their possible properties dynamically through the *.theme.xml files associated with each RAP widget
synchronization between GUI-tabs and source tab
dialogs that handle input of certain property types, e.g. ColorDialog, FontDialog, FileDialog
Redo/Undo functionality
source editor, so that theme files can be edited by hand as well
Problem Marker in source tab
syntax coloring in source tab
contribution to standard Outline view
content assist in source editor
text hover in source editor
Widgets Tab
The widgets tab contains a "widget tree" with all supported RAP widgets. All possible properties can be set for the currently selected widget.
Using the widgets tab prevents the user from thinking about the structure of a theme file, including its inheritance. So the user can just set the properties for a desired widget.
Rules Tab
A list of all rules contained in a theme file is shown in the rules tab. The selector list of each rule can be altered by adding selectors or removing applied ones. Moreover the content of a rule can be changed in a way of adding, removing or editing properties according to the desired rule.
Source Tab
The source tab gives the chance of directly editing the content in the theme file. Therefore snytax coloring and content assists are provided for the following parts of a theme file: selectors, styles, states, variants and properties. Additionally, text hover information is shown if the mouse hovers such token.
Whenever the document's content has been changed, it is parsed again and accordingly problem markers are shown. These ones can either be of the type "error marker" if the parser has found a structural disorder, or of the type "warning marker" if the css structure is valid but there are parts, which are not supported by RAP, and so will be ignored.
Prospective Features
preview for all widgets in order to see directly an visual impact when changing a property
ability to register custom widgets in order to style them as well
element hierarchy in *.theme.xml files: This xml structure should correspond with the one in the widget tree in widget tab.
Button, which will start the RAP application instantly with the currently opened theme file
preference page for editor wide settings: e.g. syntax coloring, settings for content assist, widget preview, ...
after some "refine" actions the theme file could be cluttered and unclear to read: so provide a feature that will clean up the theme file by removing unused rules or properties and merge rules with same selector list if possible
Getting the Source
SVN: https://eclipse-incub.svn.sourceforge.net/svnroot/eclipse-incub/org.eclipse.rap.themeeditor
Screenshots
Widgets Tab
- Rap-theme-editor-rules-tab.png
Rules Tab
Source Tab
