bpmext.ui.util
Contains general helper functions
Methods:
refreshTooltipPosition([toolTipElt], [anchorElt])
Refresh a tooltip positioning.
| Name | Type | Default | Description |
| toolTipElt | {object} | The tooltip element | |
| anchorElt | {object} | The element to which the tooltip is anchored |
Example
| bpmext.ui.util.refreshTooltipPosition(ttElt, refElement); |
normalizeVerticalPos([pos], [allowedValuesMap])
Returns:
{string}
Returns a vertical position. Note always 1 character
| Name | Type | Default | Description |
| pos | {string} | The position to be normalized. | |
| allowedValuesMap | {object} | The Normalized values that can be accepted. |
Example
| bpmext.ui.util.normalizeVerticalPos("Center"); |
normalizeHorizontalPos([pos], [allowedValuesMap])
Returns:
{string}
Returns a horizontal position. Note always 1 character
| Name | Type | Default | Description |
| pos | {string} | The position to be normalized. | |
| allowedValuesMap | {object} | The Normalized values that can be accepted. |
Example
| bpmext.ui.util.normalizeHorizontalPos("Right"); |
normalizeSizeStyle([sizeStyle], [allowedValuesMap])
Returns:
{string}
Returns a normalized style. Note always 1 character
| Name | Type | Default | Description |
| sizeStyle | {string} | The size style to be normalized. | |
| allowedValuesMap | {object} | The Normalized values that can be accepted. |
Example
| bpmext.ui.util.normalizeSizeStyle("LARGE"); |
showTooltip([anchorElt], [text], opts)
Returns:
{object}
Shows a tooltip.
| Name | Type | Default | Description |
| anchorElt | {object} | The element to which the tooltip is anchored | |
| text | {string} | The text of the tip | |
| opts | {object} | An object containing the vertical position, horizontal position and color style. |
Example
| var ttEl = bpmext.ui.util.showTooltip(refElement,"Show this tip" {"verticalPos":"T", "horizontalPos": "L", "colorStyle": "W" }); |
replaceCSSClass(node, [newClass], [oldClass])
Does a CSS class replacement for the specified node, and the new and old class values.
| Name | Type | Default | Description |
| node | {object} | The node which will be effected | |
| newClass | {string} | The new class to be swapped in. | |
| oldClass | {string} | The old class to be replaced. |
Example
| bpmext.ui.util.replaceCSSClass(refNode, "allignRight","allignLeft"); |
closeTooltip([toolTipElt], [anchorElt])
Closes a tooltip.
| Name | Type | Default | Description |
| toolTipElt | {object} | The tooltip element | |
| anchorElt | {object} | The element to which the tooltip is anchored |
Example
| bpmext.ui.util.closeTooltip(ttEl, refElement); |
refreshTooltips()
Refresh all tooltips.
Example
| bpmext.ui.util.refreshTooltips(); |
normalizeColorStyle([style], [allowedValuesMap])
Returns:
{string}
Returns a color style. Note always 1 character
| Name | Type | Default | Description |
| style | {string} | The color style to be normalized. | |
| allowedValuesMap | {object} | The Normalized values that can be accepted. |
Example
| bpmext.ui.util.normalizeColorStyle("Inf"); |
normalizeLabelPlacement([labelPlacement], [allowedValuesMap])
Returns:
{string}
Returns a label placement. Note always 1 character
| Name | Type | Default | Description |
| labelPlacement | {string} | The label placement to be normalized. | |
| allowedValuesMap | {object} | The Normalized values that can be accepted. |
Example
| bpmext.ui.util.normalizeLabelPlacement("Right"); |
normalizeIconPosition([iconPosition], [allowedValuesMap])
Returns:
{string}
Returns an icon position. Note always 1 character
| Name | Type | Default | Description |
| iconPosition | {string} | The icon position to be normalized. | |
| allowedValuesMap | {object} | The Normalized values that can be accepted. |
Example
| bpmext.ui.util.normalizeIconPosition("Right"); |