Web Part: Jazz Editor

Modified on 2015/06/17 16:03 by Charles — Categorized as: Jazz Web Parts

Table of Contents [Hide/Show]


   Create Jazz Editor Web Part
      Access
      Features
      Edit Properties


Create Jazz Editor Web Part

  • The Jazz Editor Web Part is is fairly versatile. It can be used to display data in different formats.
  • Display the Jazz object in an editor or as read-only parameters.
  • Display the logged-in user's profile in an editor or as read-only parameters.
  • Prompt the user to enter new Jazz objects in an input form
  • Show the underlying properties and methods of the Jazz object using Test Mode
  • Form Layout can be selected to display properties in different formats.
  • Use the Command Display Mode to select what commands get displayed.
  • Create new classes by displaying links in the form. Click a link and a new Jazz object is created and appears in the edit form.

Figures

Figures 1 - 6 show the Jazz Editor used in different ways.

Figure 1 shows the Web Part used as an Editor with properties displayed in a row.

Figure 2 shows a list of links that represent classes. Click a link and a new Jazz object is created and appears in the edit form.

Figure 3 shows the Web Part used to view properties of a Jazz object.

Figure 4 shows the Web Part used as an editor for the logged-in user's profile.

Figure 5 shows the Web Part used as an viewer for the logged-in user's profile.

Figure 6 shows the Web Part used as an input form. Select the Class Name for the type of Jazz object to prompt the user for.
Figure 1: Jazz Editor

Figure 1: Jazz Editor


Figure 2: Jazz Create classes (click a link)

Figure 2: Create new Jazz objects


Figure 3: Jazz Viewer

Figure 3: Jazz Viewer


Figure 4: Jazz Logged-in User Profile Editor

Figure 4: Jazz Logged-in User Profile Editor


Figure 5: Jazz Logged-in User Profile View

Figure 5: Jazz Logged-in User Profile Viewer


Figure 6: Jazz Input Form

Figure 6: Jazz Input Form



Access

This Web Part is accessed by the Jazz Base Library.

Features

The Web Part has a number of options, including:

Edit Properties

Custom Edit properties include:
  • Title Class: The CSS style used for the title of the Web Part.
  • Label Class: The CSS style used for the labels in the Web Part.
  • Form Layout: The format for how the data is displayed.
    • Row: Display properties as a label and the value in the same row.
    • Column: Display properties as a label and the value in the same column.
    • Tile: Display properties as a label in the first row and the value indented in the next row.
    • Cell Format: Display multiple properties in the same cell of a row.
  • Edit Mode: changes the usage of the form.
    • Editor: Display the properties of the Jazz object in edit mode.
    • Viewer: Display the properties of the Jazz object as read-only.
    • Edit Profile: Display the properties of the logged-in user's profile in edit mode.
    • View Profile: Display the properties of the logged-in user's profile as read-only.
    • Input Form: Display the properties of the selected class name as an input form.
    • Test Mode: Display the properties and methods of the Jazz object as their primitive properties.
  • Default Workspace Name: the name of the workspace that a new object is saved to
  • Command Display Mode: changes what commands are displayed.
    • All: Display form and configured commands.
    • None: Display no commands.
    • Form: Display form commands only.
    • Configuration: Display configured commands only.
    • Save-only: Display configured commands when form can be saved.
  • Class Name: the name of the class selected when the form is used as an input form.
  • Create new classes?: if checked, then display the links that prompt the user to create new classes.
  • Create Classes: a semi-colon delimited list of class names used to create links.
  • Create Display Names: a semi-colon delimited list of display names used to create links.
  • Config File: an xml-based file that contain workflow configuration parameters used to customize the display of a Jazz object.
  • Show Print Command?: if checked, displays an icon that if clicked prints just the editor.
  • Show/Hide State: identifies if the web part is shown/hidden when first displayed. User is allowed to change the state.
  • Jazz Common Edit Properties
Figure 7: Editor for Jazz Editor

Figure 3a: Editor for Jazz Editor