Content

storageunitrenderer Element

Description

Related Topics

Examples

General

Storage Unit Layouts

Options

Properties

Mechanics

Internal Functionality

   

 

Description

The storageunitrenderer Element renders a Storage Unit SDI in graphical format and provides the following operational capabilities:

• Inserts an SDI into a Storage Unit.
• Removes an SDI from a StorageUnit.
• Marks a Storage Unit as reserved or empty.
• Moves an SDI between child Storage Units.

The Element performs these operations client-side (for user interaction); it does not save or otherwise modify data... that is handled by the page and associated JSP framework. Internally, the Element handles interaction between Trackable Items and SDIs.

See Mechanics for more details regarding internal functionality of the storageunitrenderer Element.

Related Topics

Each Storage Unit is associated with a Storage Unit Type, which defines properties of Storage Units rendered by this Element.

See Storage Unit Types for additional information.

Examples
General

This general example shows how storageunitrenderer displays a Storage Unit defined by the Grid Storage Unit Type (in this case, a 9x9 Box):

 

 

Property Name Description
1.
 Show Determines which Display Format is displays. The Display Format is defined in the Storage Unit Type Grid Properties.
2.
 Increase or decrease the Font. Click the A- to decrease the Font size or A+ to increase.
3.
 The Legend provides a key to the colors used within the grid. Click the gear open the Options tab.
4.
 Configured Detail tabs.
5.
 The rendered cells as determined by the Cell Properties.

 

StorageUnitLayouts

To render Storage Units, R4 provides the following Storage Unit Layouts defined by Storage Unit Types:

Grid Linear Circular

Options

The Options tab lets users define features and fill order when assigning Storage:

Options Description

 

Grid Options shown

 

Legend shows cell status

Option Indicates...
Show Info Shows cell info onMouseover.

Show
Location
Index		 Shows index number within
each cell.
Fill Direction Default fill directions:

Grid:

Horizontal:Left to Right
Vertical:Top to Bottom

Linear:

Horizontal:Left to Right
Vertical:Top to Bottom

Circular:

Horizontal:Clockwise

storageunitrenderer Element Properties
Property Name Description
Show Yes renders the Element.
Show Legends Deprecated. Clicking the Legend Icon shows the legend (see the example above).
Mode Determines the edit/display mode: Edit (editable) or View (read-only).
Tab Properties of the tab that adds the detail items. In the example above, adding a Limit Type adds detail items to the Parameter Limits and Parameter Details tabs.
Property Name Description
ShowYes (default) displays the Element.
TextText displayed in the tab header.
WidthWidth of the tab in pixels (defaults to the size of the tab).
body WidthWidth of the content body (text area beneath the tab). The default is 100%.
body HeightFixed height of the content body. A scrollbar is added as required.
ExpandableYes (default) allows the tab to be expanded and collapsed. No disables this feature and the tab is always expanded.
ExpandedYes (default) initially expands the tab if Expandable property is set to Yes.
HighlightYes (default) highlights the tab on a mouseover event. The CSS defines this.
TipHelp text to appear on mouseover.
IdIdentifier of the Element (defaults to the Element name).
GroupDefines a tab group. See Tab Groups and Field Groups in the maint Element.
Cell Properties Determines attributes of cells in the rendered layout:
Property NameDescription
WidthWidth of the cell in pixels.
HeightHeight of the cell in pixels.
Show LocationDeprecated. Yes shows the index number within each cell (see Options).
ColorsColors identifying cells having the statuses described below. Enter the HTML hex color code, e.g., #FFFFFF.
Cell StatusDescription
EmptyEmpty cell.
FilledOccupied cell.
ReservedReserved cell.
StartSelected cell (onClick).
BorderCell border.
By Filled Sample TypeConfigure different colors to indicate different Sample Types in a cell.
Property Name Description
Sample TypeChoose the Sample Type for which you want to define a color.
Background ColorBackground color of the cell.
Foreground ColorForeground (text) color.
Show InformationDeprecated. Yes shows information concerning cell contents onMouseover (see Options).
header Properties Determines attributes of the header displayed above the rendered layout:
Property Name Description
ShowDeprecated (header is always shown). Whether or not to show the header.
ColorBackground color of the header.
Font ColorColor of font used in the header.

Mechanics
Internal Functionality

The storageunitrenderer Element:

1. Gets the StorageUnit Id from the pagedata object.
2. Gets the StorageUnitType from the StorageUnit SDI (see Storage Unit Types).
3. Gets the Property Tree Node Id from the StorageUnitType.
4. Parses the Property Tree value from the node.
5. Reads the defined Layout class (the element is a wrapper on this class), which is a custom class instantiated by the Element to render StorageUnit. The storageunitrenderer Element then:
a.Instantiates the layout class.
b.Provides access to the Element's properties to the layout class.
c.Provides access to the StorageUnit's properties to the layout class.
d.Provides access to the StorageUnitType's properties to the layout class.
e. Invokes the getHtml() method, which returns the rendered html.