new LegendElement(dom_element, control_info)
Creates a LegendElement object used to hold information about legend elements
Parameters:
Name | Type | Description |
---|---|---|
dom_element |
DOMelement | The dom element object representing the legend element |
control_info |
ControlInfo | Information about the parent controls |
- Source:
- scripts/cache_controls.js, line 1708
Properties:
Name | Type | Description |
---|---|---|
dom_element |
DOMElement | Reference to the dom element representing the legend element |
cache_id |
String | String that uniquely identifies the cache element object in the cache |
document_order |
Number | Ordinal position of the legend element in the document in relationship to other legend elements |
child_cache_elements |
Array | Array of child cache control elements as part of cache control tree |
control_type |
Number | Constant indicating the type of cache control object |
fieldset_element |
FieldsetElement | Reference to any fieldset elements this legend is nested in |
computed_label |
String | Text content of the legend element |
computed_label_for_comparison |
String | Label for comparison (lowercase, space normalization and trimmed) |
Methods
-
<static> addChildControl(control_element)
-
Adds a cache control element to the tree representation of control elements
Parameters:
Name Type Description control_element
WidgetElement | ButtonElement | FieldsetElement | FormElement | InputElement | LabelElement | LegendElement | OptgroupElement | OptionElement | SelectElement | TextareaElement Cache control element object to add - Source:
- scripts/cache_controls.js, line 1751
-
<static> getAttributes(unsorted) → {Array}
-
Returns an array of attributes for the element, sorted in alphabetical order
Parameters:
Name Type Description unsorted
Boolean If defined and true the results will NOT be sorted alphabetically - Source:
- scripts/cache_controls.js, line 1799
Returns:
Returns a array of attribute display object- Type
- Array
-
<static> getCacheProperties(unsorted) → {Array}
-
Returns an array of cache properties sorted by property name
Parameters:
Name Type Description unsorted
Boolean If defined and true the results will NOT be sorted alphabetically - Source:
- scripts/cache_controls.js, line 1823
Returns:
Returns a array of cache property display object- Type
- Array
-
<static> getCachePropertyValue(property) → {String|Number}
-
Returns the value of a property
Parameters:
Name Type Description property
String The property to retreive the value - Source:
- scripts/cache_controls.js, line 1848
Returns:
Returns the value of the property- Type
- String | Number
-
<static> getEvents() → {Array}
-
Returns an array of events for the element, sorted in alphabetical order
- Source:
- scripts/cache_controls.js, line 1871
Returns:
Returns a array of event item display objects- Type
- Array
-
<static> getNodeResults() → {Array}
-
Returns an array of node results in severity order
- Source:
- scripts/cache_controls.js, line 1769
Returns:
Returns a array of node results- Type
- Array
-
<static> getStyle() → {Array}
-
Returns an array of style items
- Source:
- scripts/cache_controls.js, line 1783
Returns:
Returns a array of style display objects- Type
- Array
-
<static> toString() → {String}
-
Returns a text string representation of the legend element
- Source:
- scripts/cache_controls.js, line 1886
Returns:
Returns string represention the LegendElement object- Type
- String