Attribute Drop-down

Deprecation Warning! The content below is only applicable for use within deprecated 1.x versions of Rally's App SDK. Use of the components and/or code on this page is not supported. To develop custom apps within our current environments, please see App SDK 2.0 documentation.

The Attribute Drop-down component can be used to give a searchable selection box for the allowed values of a Rally object attribute. For example, you could use it to create a component that would display the available tags or owners on a story.

attribute

Attribute Drop-down includes the following topics:

Create an Attribute Drop-down

First include the App SDK JavaScript:

<script type="text/javascript" src="/apps/[version]/sdk.js"></script>

Instantiate a new AttributeDrop-down:

var dropdown = new rally.sdk.ui.AttributeDropdown(config, rallyDataSource);

The parameters for rally.sdk.ui.AttributeDropdown are as follows:

Parameter Description Example
config* A configuration object { type: "defect", attribute: "owner" }
rallyDataSource* An instance of rally.sdk.data.RallyDataSource new rally.sdk.data.RallyDataSource
         ("__WORKSPACE_OID__",
          "__PROJECT_OID__",
          "__PROJECT_SCOPING_UP__",
          "__PROJECT_SCOPING_DOWN__"
)
  * = required parameter

The Attribute Drop-down configuration object supports the following properties:

Parameter Description
Example
showLabel
If showLabel is true then the label will be shown.
Defaults to true if label is specified, false otherwise.
true
label The text for the description that will be placed next to the drop-down.
"Label Text"
labelPosition
Where the label will be displayed, either before or after.
"before"
type* The Rally object type containing the requested value. "Defect", "HierarchicalRequirement", "Story"
attribute* The name of a Rally attribute on the specified type. "Owner", "Tags", "State"
defaultDisplayValue The default text that will be displayed. If the defaultDisplayValue is not in the returned results it will be ignored. "Charles"
rememberSelection
Whether to persist the current selection as the default for future sessions. Default = true.
false
defaultDisplayValue
The first display value the drop-down will be set to.
If rememberSelection is true, the remembered value is given priority over this default.
"High Attention"
defaultValue
The first value the drop-down will be set to. If rememberSelection is true, the remembered value is given priority over this default.
"High Attention"
width Specify the drop-down's width in pixels.
By default, the drop-down will be sized according to its contents.
200
  * = required parameter

Display an Attribute Drop-down

Once created, use the display method to display the drop-down :

CDATA[ dropdown.display(domElement, onClick);

Parameter Description
Example
domElement* The element in which to display the drop-down.
This may be either an element or an element ID.
"dropdownDiv",
document.getElementById("dropdownDiv")
onSelectionChanged A callback function that will be executed each time the user changes the components value.
This callback will also be called once when the component is finished rendering.
function onSelectionChanged(sender,
eventArgs) {
   var selectedDisplayValue =
eventArgs.displayedValue;
   var selectedValue = eventArgs.value;
}
  * = required parameter

Public methods

Method Parameters Description
Example
display See above Display the drop-down. See above
destroy - Removes this component. dropdown.destroy();
getValue - Returns the underlying value of the displayed text. For references such as user it will return the unique reference to that user. var value = dropdown.getValue();
getDisplayedValue - Returns the displayed value of the drop-down. var displayed =
   dropdown.getDisplayedValue();
getItems - Returns an object containing all the the data used to create the drop-down. var items = dropdown.getItems();
getSelectedItem - The currently selected item. {label: "Selection1", value:
"Selection1"}
getQueryFromSelected - A Query object to be used with Rally Data Source. queryObj.query =
dropdown.getQueryFromSelected();
rallyDataSource.findAll(queryObj);
setDisplayedValue displayedValue* Set the selected item of the drop-down based on the specified display value. dropdown.setDisplayedValue("None");
setValue value* Set the selected item of the drop-down based on the specified value. dropdown.setValue("None");
  * = required parameter

Events

Events are used to notify consumers of a component when actions occur.
The following methods are provided in order to interact with this component's events:

}
Method Parameters Description Example
addEventListener eventName*, listener*, scope Registers the specified listener with the component's queue for the specified event and returns an object which can be used to remove the event listener later. The listener parameter should be a function with two parameters: 1) the component that fired the event; 2) an eventArgs object with properties specific to the event being fired. This function will be called by the component when the event occurs. If the optional scope parameter was specified the function will be called on that object (like scope.listener(sender, args);). function listener(sender, eventArgs) {
   //Respond to event
}
var eventObj =
component.addEventListener(eventName,
listener);
removeEventListener eventObj* Unregisters the specified event from the component.
The eventObj parameter should be the return value of addEventListener() when the listener was originally registered.
var eventObj =
component.addEventListener(...); component.removeEventListener(eventObj);
getValid Events - Returns an object with a property for each event name supported by the component. This is useful for passing as the first parameter to addEventListener(). var eventName =
component.getValidEvents().onClick;
  * = required parameter

The Attribute Drop-down component supports the following events:

Event Name Description Event Arguments Example
onChange Fired when a new value is selected The eventArgs object passed to any event listeners contains the following properties:
value: Returns the underlying value for the drop-downs current selection.
displayedValue: Returns the underlying displayed text for the drop-downs current selection.
item: Returns the object value that was used for the current selection.
dropdown.addEventListener("onChange",
   onChangeEventListener);
onLoad Fired when the component is loaded The eventArgs object passed to any event listeners contains the following properties:
value: Returns the underlying value for the drop-downs current selection.
displayedValue: Returns the underlying displayed text for the drop-downs current selection.
items: Returns all the items used to display this component.
item: Returns the object value that was used for the current selection.
dropdown.addEventListener("onLoad",
   onLoaded);
onDataRetrieved Fired when the drop-down data has been retrieved but before it is bound (useful for adding or removing items, sorting and so on) The eventArgs object passed to any event listeners contains the following properties:
items: An array of the retrieved items.
displayValueProperty: The property name corresponding to the display value of each item.
valueProperty: The property name corresponding to the value of each item.
function onDataRetrieved(a, eventArgs) {
   //Add an "All" option
   var all = {};
   all[eventArgs.displayValueProperty] = "All";
   all[eventArgs.valueProperty] = "All";
   eventArgs.items.unshift(all);
}
dropdown.addEventListener("onDataRetrieved",
   onDataRetrieved);]]>

Example

Copy and paste the following into a Rally custom page.

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<!-- Copyright (c) 2011 Rally Software Development Corp. All rights reserved -->
<html>
<head>
   <title>Attribute dropdown Example</title>
   <meta name="Name" content="Component Example: Attribute Dropdown" />
   <meta name="Version" content="1.26" />
   <meta name="Vendor" content="Rally Software" />

   <script type="text/javascript" src="/apps/1.26/sdk.js"></script>
   <script type="text/javascript">

     function dropdownChanged(dropdown, eventArgs) {
       var selectedItem = eventArgs.item;
       var selectedValue = eventArgs.value;
     }

     function onLoad() {
       var rallyDataSource = new rally.sdk.data.RallyDataSource('__WORKSPACE_OID__',
                                                             '__PROJECT_OID__',
                                                             '__PROJECT_SCOPING_UP__',
                                                            '__PROJECT_SCOPING_DOWN__');

       var config = {
           type : "defect",
           attribute : "owner"
         };

       var attributeDropdown = new rally.sdk.ui.AttributeDropdown(config,       rallyDataSource);
      attributeDropdown.display("aDiv", dropdownChanged);
    }

     rally.addOnLoad(onLoad);

   </script>
</head>
<body>
   <div id="aDiv"></div>
</body>
</html>

Feedback

Need more help? The CA Agile Central Community is your one-stop shop for self-service and support. To submit feedback or cases to CA Agile Central Support, find answers, and collaborate with others, please join us in the CA Agile Central Community.