= Component registry FLEX interface (!BrowserGui) =

This part of the [[ComponentRegistryAndEditor|Component Registry and Editor]] is a graphical interface to the [[ComponentRegistryRest|Component Registry REST service]] with added graphical editing features for components and profiles.

The production version of the !BrowserGui is available online at [http://catalog.clarin.eu/ds/ComponentRegistry].

----
== Contents ==
[[PageOutline(1-3, , inline)]]

----

== Getting code ==

 * You can browse the code [source:ComponentRegistry/trunk/ComponentBrowserGui/ here (trunk)]
----
== Building and Deploying ==

=== Building ===

The !BrowserGui is part of the modular Maven project [[ComponentRegistryAndEditor|ComponentRegistry]]. The module can be built separately without any internal dependencies (this is not the case for the [[ComponentRegistryRest|REST service]], which depends on the !BrowserGui).

The !BrowserGui can be built using Maven. The project is configured to use [http://flexmojos.sonatype.org/ FlexMojos] for building the Flex application from source. Alternatively, the project can be built manually using the [http://opensource.adobe.com/wiki/display/flexsdk/Flex+SDK Flex SDK], optionally wrapped by [http://www.adobe.com/products/flash-builder.html Adobe Flash Builder].

=== Deployment ===

The !BrowserGui is a client application that has to be embedded in a web page. For it to work properly, some parameters have to be passed to it. The [[ComponentRegistryRest|REST service]] package contains a [source:/ComponentRegistry/trunk/ComponentRegistry/src/main/webresources/index.jsp single JSP page] in the root of the web app directory that takes care of it. So deploying the REST service will automatically deploy the !BrowserGui as well.

== Developing in !FlashBuilder ==
A !FlashBuilder project can be generated using a maven target. Instructions for this can be found in the [source:/ComponentRegistry/trunk/README README] file of the project under ''Creating initial setup files''. **Please carefully read these instructions before you get started**. After generation of the project files, the project can be opened in the Eclipse-based [http://www.adobe.com/nl/products/flash-builder.html FlashBuilder] from Adobe (free educational license) .

=== Debugging ===
For instructions on debugging the Flash UI, in particular the parts that require authentication, consult the [source:/ComponentRegistry/trunk/README README] file.
----

== Design ==

TODO

---

== Usage ==

The interface display three main views that can be selected in the top menu : "Browse", "Edit", "Import"

Editor and import features will be disabled until the use has authenticated.

=== Browse ===
Will allow the user to select Profiles or Components. Clicking on either of them show all the registered Profiles or Components as a list. The selection of an item in the list will fill in the below panel with information about the selected profile or component.


=== Edit ===
 The editor view allows the user to create a new !Profile/Component or edit an already existing !Profile/Component.


=== Import ===
This last button Import, as stated by the name is straight forward. The user can register components and profiles as xml files from the user files system.

More information is available in the [source:/ComponentRegistry/trunk/docs/ComponentRegistryReferenceManual.docx ComponentRegistry manual].