List of functionality covered for the implementation of Oxygen author.

[sebastienlavandier]

Hello,

For my project, I don't know yet if I must develop a plugin for the Oxygen author, or use an applet, or use the Oxygen component in a swing application.

So, I want to know if it exist a list of functionality cover for each case ?
And where I can find it.

Thanks in advance for your answer.
Regards.

[Radu]

Hi Sebastien,

Or you could do both . Probably you could have a lot of common Java code for both integrations.

If you develop a plugin for XML Author, you will have a larger user base if your plugin is intended for general use. You can make the plugin available using our new update-site feature:
http://www.oxygenxml.com/doc/ug-oxygen/ ... d-ons.html

The Author Component is limited to creating Author pages. The standalone version of Oxygen allows users to edit in multiple pages like Text/Grid or Author.

The standalone version of Oxygen also has other additional views like the Project view allowing users to organize their resources.
It also has support to run transformation scenarios to publish the XML content to various output sources, support for opening ZIP archives, resources from FTP or WebDav servers, support for connecting to various databases, etc. A list of XML Author features can be found here:

http://oxygenxml.com/difference_editor_author.html

Also, if you want to open multiple XML documents using the author component you will have to perform your own management of the opened resources, to add them to a JTabbedPane for example.

It probably depends on your target user group.

Regards,
Radu

[sebastienlavandier]

Thank you, Radu, for your quick answer, but I don't know yet what is the best solution.

I think we have found a solution to manage the multiple xml documents (maybe with the same component that Oxyen use) and we don't want create xml documents from our application but only edit them in the Author view.

I want to be sure before starting some developements. Do you have a list to compare the standalone solution and the component solution ?

Thanks in advance.
Regards

[Radu]

Hi Sebastien,

Sorry, but we do not have such a list.
If the Author Component is enough for you, then you should probably go in this direction as the price for a commercial license is half the price of a license of XML Author.

Regards,
Radu

[sebastienlavandier]

For answer at the question, this link is very useful :
http://oxygenxml.com/doc/ug-editor/topi ... t_faq.html

Regards
Sébastien.

[sebastienlavandier]

Hello,

What do you want to say by "The Author Component is limited to creating Author pages" ?
We can't, or we can create a limited number of pages ?

Regards.
Sébastien

[Radu]

Hi Sébastien,

If you open an XML file in the standalone version of Oxygen XML Author you will see that it can be edited in three pages: Text (showing the XML as it is), Grid (showing the tree structure of the document) and Author (visual XML editing).
The Author Component can edit the XML only in the Author page. But you can create as many Author pages as you want for as many XML files the user might want to open.

Regards,
Radu

[sebastienlavandier]

Hello,

I'm surprised I don't have access to the validate button in the toolbar (by using the component) and however it's write in the F.A.Q :
"You can mount on your custom toolbar all actions available in the standalone Oxygen application for editing in the Author page. This includes custom actions defined in the framework customized for each XML type. "

I really can't have access to the XML validation ?
else how I can do that ?

Regards.
Sébastien.L

[Radu]

Hi Sébastien,

The author component automatically validates the XML document while it is modified. The validation markers appear on the validation stripe located near the vertical scroll bar.
The problem is that a toolbar "Validate" button would have to present the problems in a list and for now there is no such built-in list of problems which could be displayed for the Author Component.

But there is API to add in the Author Component a ValidationProblemsFilter so basically you could show the problem in your own JList:

Code: Select all

JList problemsList = new JList();

		final DefaultListModel dlm = new DefaultListModel();

		problemsList.setModel(dlm);

		add(new JScrollPane(problemsList), BorderLayout.SOUTH);

		authorComponentProvider.getWSEditorAccess().addValidationProblemsFilter(new ValidationProblemsFilter() {

			public void filterValidationProblems(

					ValidationProblems validationProblems) {

				List<DocumentPositionedInfo> problems = validationProblems.getProblemsList();

				dlm.clear();

				if(problemsList != null) {

					for (int i = 0; i < problems.size(); i++) {

						dlm.addElement(problems.get(i));

					}

				}

			}

		});

		problemsList.setCellRenderer(new DefaultListCellRenderer() {

			public Component getListCellRendererComponent(JList list,

					Object value, int index, boolean isSelected,

					boolean cellHasFocus) {

				JLabel label = (JLabel) super.getListCellRendererComponent(list, value, index, isSelected,

						cellHasFocus);

				label.setText(((DocumentPositionedInfo)value).getMessageWithSeverity());

				return label;

			}

		});

What's missing is a way to double click a displayed message and navigate in the Author page to the problem's location. We'll try to add API in the component to map a DocumentPositionedInfo to a range of offsets in the Author page.
I'll update the forum thread when we add the API.

Regards,
Radu

[sebastienlavandier]

Thanks you Radu.

[Radu]

Hi,

Oxygen 14.1 was just released and the newest Author Component Project contains in the AuthorComponentSample class an example of how a validation list can be implemented.

Regards,
Radu

[sebastienlavandier]

Thanks you Radu.