FormTimeRangeField¶
Definition¶
Extends¶
Extended By¶
None
Description¶
Time Range field
Method Summary¶
| Owner | Name | Return Type | Description |
|---|---|---|---|
| FormField | exportConfig() | Map | Exports this field's configuration to a map. |
| DashboardResource | getCallback(callbackName) | Callback | Returns a callback by name |
| DashboardResource | getCallbacks() | Map | Returns a map of all callback definitions. |
| DashboardResource | getChildren() | List | Returns a list of the child dashboard resources. |
| Object | getClassName() | String | Returns the string name of this object's class type. |
| FormField | getCssClass() | String | Returns the CSS class. |
| DashboardResource | getDRI() | String | Returns the Dashboard Resource Indicator (DRI) as a string. DRI is the unique identifier of this resources within the entire dashboard. |
| DashboardResource | getDashboardResourceType() | String | Returns the Dashboard Resource Type as a string |
| FormField | getDisabled() | Boolean | Returns true if field is disabled, false otherwise. |
| FormField | getDisplayMode() | String | DEPRECATED, use isVisible instead. Returns display type of field. Will return "ABSOLUTE" if field is displayed using absolute positioning. Will return "HTML" if field is displayed using form HTML. |
| FormField | getFieldValue(varName) | Object | Returns the value of the field with the associated varName for the form that owns this field. |
| DashboardResource | getFormula(formulaName) | Formula | Returns a Formula given the formula name. |
| DashboardResource | getFormulaNames() | Set | Returns a set of the names of all formulas for this object. |
| DashboardResource | getFormulas() | Map | Returns a map of all available formulas for this object. The key is the formula name. |
| FormTimeRangeField | getHourEnd() | Number | Returns a Number that is the hour (1-12) on the RIGHT hand side of the time range in UTC. |
| FormTimeRangeField | getHourEnd(timeZoneId) | Number | Returns a Number that is the hour (1-12) on the RIGHT hand side of the time range in specified time zone. |
| FormTimeRangeField | getHourOfDayEnd() | Number | Returns a Number that is the hour (0-23) on the RIGHT hand side of the time range in UTC. |
| FormTimeRangeField | getHourOfDayEnd(timeZoneId) | Number | Returns a Number that is the hour (0-23) on the RIGHT hand side of the time range in specified time zone. |
| FormTimeRangeField | getHourOfDayStart() | Number | Returns a Number that is the hour (0-23) on the LEFT hand side of the time range in UTC. |
| FormTimeRangeField | getHourOfDayStart(timeZoneId) | Number | Returns a Number that is the hour (0-23) on the LEFT hand side of the time range in specified time zone. |
| FormTimeRangeField | getHourStart() | Number | Returns a Number that is the hour (1-12) on the LEFT hand side of the time range in UTC. |
| FormTimeRangeField | getHourStart(timeZoneId) | Number | Returns a Number that is the hour (1-12) on the LEFT hand side of the time range in specified time zone. |
| FormTimeRangeField | getIsPmEnd() | Boolean | Returns true if the hour is in PM on the RIGHT hand side of the time range in UTC. |
| FormTimeRangeField | getIsPmEnd(timeZoneId) | Boolean | Returns true if the hour is in PM on the RIGHT hand side of the time range in specified time zone. |
| FormTimeRangeField | getIsPmStart() | Boolean | Returns true if the hour is in PM on the LEFT hand side of the time range in UTC. |
| FormTimeRangeField | getIsPmStart(timeZoneId) | Boolean | Returns true if the hour is in PM on the LEFT hand side of the time range in specified time zone. |
| DashboardResource | getLRI() | String | Returns the Localized Resource Indicator (LRI) as a string. LRI is the unique identifier of this resource with the parent element. |
| FormField | getLabel() | String | Returns the label associated with this field. |
| FormField | getLabelTooltip() | String | Returns the tooltip associated with this field's label. |
| FormTimeRangeField | getMillisEnd() | Number | Returns a Number that is the millisecond on the RIGHT hand side of the time range in UTC. |
| FormTimeRangeField | getMillisEnd(timeZoneId) | Number | Returns a Number that is the millisecond on the RIGHT hand side of the time range in specified time zone. |
| FormTimeRangeField | getMillisStart() | Number | Returns a Number that is the millisecond on the LEFT hand side of the time range in UTC. |
| FormTimeRangeField | getMillisStart(timeZoneId) | Number | Returns a Number that is the millisecond on the LEFT hand side of the time range in specified time zone. |
| FormTimeRangeField | getMinuteEnd() | Number | Returns a Number that is the minute on the RIGHT hand side of the time range in UTC. |
| FormTimeRangeField | getMinuteEnd(timeZoneId) | Number | Returns a Number that is the minute on the RIGHT hand side of the time range in specified time zone. |
| FormTimeRangeField | getMinuteStart() | Number | Returns a Number that is the minute on the LEFT hand side of the time range in UTC. |
| FormTimeRangeField | getMinuteStart(timeZoneId) | Number | Returns a Number that is the minute on the LEFT hand side of the time range in specified time zone. |
| DashboardResource | getOwner() | DashboardResource | Returns the DashboardResource that owns this object. |
| FormField | getPanel() | FormPanel | Returns the panel that contains this field. |
| FormField | getPosition() | Rectangle | Returns a Rectangle object representing the field's position as (x,y,w,h). |
| FormTimeRangeField | getSecondEnd() | Number | Returns a Number that is the second on the RIGHT hand side of the time range in UTC. |
| FormTimeRangeField | getSecondEnd(timeZoneId) | Number | Returns a Number that is the second on the RIGHT hand side of the time range in specified time zone. |
| FormTimeRangeField | getSecondStart() | Number | Returns a Number that is the second on the LEFT hand side of the time range in UTC. |
| FormTimeRangeField | getSecondStart(timeZoneId) | Number | Returns a Number that is the second on the LEFT hand side of the time range in specified time zone. |
| FormField | getValue() | Object | Returns the value associated with this field. |
| FormField | getVariableName() | String | Returns the variable name associated with this field. |
| DashboardResource | invokeCallback(callbackName, args) | Object | Executes the specified callback definition and returns the result from the callback. |
| FormField | isAtDefaultPosition() | Boolean | Returns whether field is at the default position specified in field editor. |
| FormField | isTransient() | Boolean | Returns whether a field is transient. |
| FormField | isVisible() | Boolean | Returns true iff this field is visible, false otherwise. |
| FormField | resetCssClass() | Boolean | Resets CSS class to default (as configured in AMI editor). |
| FormField | resetDisabled() | Boolean | Resets the disabled flag to default (as configured in AMI editor). |
| FormField | resetPosition() | Boolean | Resets field position to default position specified in field editor. |
| FormField | setCssClass(cssStyle) | Boolean | Sets CSS class. Returns empty string for no css. |
| FormField | setDisabled(disabled) | Boolean | Set the disabled status of the field (true for disabling, false for enabling). |
| FormField | setDisplayMode(mode) | Boolean | DEPRECATED, use setVisible instead. Sets display mode of field. Setting to "ABSOLUTE" will display field using absolute positioning. Setting to "HTML" will allow field to be displayed using the form HTML. Any other input will throw an exception. |
| FormField | setFieldValue(key, value) | Boolean | Sets the key value pair to this portlet's attributes and returns true if successful. For key, put in the field's variable name, then set the value. |
| FormField | setLabelTooltip(tooltip) | Boolean | Sets the label tooltip. |
| FormField | setPosition(x, y, w, h) | Boolean | Sets the field position. Specify (x,y) position, width, and height in pixels. Passing null to an argument is equivalent to not setting a value for that specific argument. |
| FormField | setPosition(rect) | Boolean | Sets the position, if the position is null then resets the overrides |
| FormTimeRangeField | setRange(startValue, endValue) | Boolean | Sets the time range's start and end value. |
| FormField | setValue(value) | Boolean | Set this field's value. This is a generic set method that is available for every field in AMI. For FormRangeSlider and FormImage field, it is advisable to use their own setValue() method. |
| FormField | setVisible(visible) | Boolean | Sets the visibility of this field. Returns false iff the argument is null, true otherwise. |
| Object | toJson() | String | Returns a json representation of this object. |
Method Definitions¶
getHourEnd()¶
Number FormTimeRangeField::getHourEnd()
Description¶
Returns a Number that is the hour (1-12) on the RIGHT hand side of the time range in UTC.
getHourEnd(timeZoneId)¶
Number FormTimeRangeField::getHourEnd(String timeZoneId)
Description¶
Returns a Number that is the hour (1-12) on the RIGHT hand side of the time range in specified time zone.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| timeZoneId | String |
getHourOfDayEnd()¶
Number FormTimeRangeField::getHourOfDayEnd()
Description¶
Returns a Number that is the hour (0-23) on the RIGHT hand side of the time range in UTC.
getHourOfDayEnd(timeZoneId)¶
Number FormTimeRangeField::getHourOfDayEnd(String timeZoneId)
Description¶
Returns a Number that is the hour (0-23) on the RIGHT hand side of the time range in specified time zone.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| timeZoneId | String |
getHourOfDayStart()¶
Number FormTimeRangeField::getHourOfDayStart()
Description¶
Returns a Number that is the hour (0-23) on the LEFT hand side of the time range in UTC.
getHourOfDayStart(timeZoneId)¶
Number FormTimeRangeField::getHourOfDayStart(String timeZoneId)
Description¶
Returns a Number that is the hour (0-23) on the LEFT hand side of the time range in specified time zone.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| timeZoneId | String |
getHourStart()¶
Number FormTimeRangeField::getHourStart()
Description¶
Returns a Number that is the hour (1-12) on the LEFT hand side of the time range in UTC.
getHourStart(timeZoneId)¶
Number FormTimeRangeField::getHourStart(String timeZoneId)
Description¶
Returns a Number that is the hour (1-12) on the LEFT hand side of the time range in specified time zone.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| timeZoneId | String |
getIsPmEnd()¶
Boolean FormTimeRangeField::getIsPmEnd()
Description¶
Returns true if the hour is in PM on the RIGHT hand side of the time range in UTC.
getIsPmEnd(timeZoneId)¶
Boolean FormTimeRangeField::getIsPmEnd(String timeZoneId)
Description¶
Returns true if the hour is in PM on the RIGHT hand side of the time range in specified time zone.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| timeZoneId | String |
getIsPmStart()¶
Boolean FormTimeRangeField::getIsPmStart()
Description¶
Returns true if the hour is in PM on the LEFT hand side of the time range in UTC.
getIsPmStart(timeZoneId)¶
Boolean FormTimeRangeField::getIsPmStart(String timeZoneId)
Description¶
Returns true if the hour is in PM on the LEFT hand side of the time range in specified time zone.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| timeZoneId | String |
getMillisEnd()¶
Number FormTimeRangeField::getMillisEnd()
Description¶
Returns a Number that is the millisecond on the RIGHT hand side of the time range in UTC.
getMillisEnd(timeZoneId)¶
Number FormTimeRangeField::getMillisEnd(String timeZoneId)
Description¶
Returns a Number that is the millisecond on the RIGHT hand side of the time range in specified time zone.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| timeZoneId | String |
getMillisStart()¶
Number FormTimeRangeField::getMillisStart()
Description¶
Returns a Number that is the millisecond on the LEFT hand side of the time range in UTC.
getMillisStart(timeZoneId)¶
Number FormTimeRangeField::getMillisStart(String timeZoneId)
Description¶
Returns a Number that is the millisecond on the LEFT hand side of the time range in specified time zone.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| timeZoneId | String |
getMinuteEnd()¶
Number FormTimeRangeField::getMinuteEnd()
Description¶
Returns a Number that is the minute on the RIGHT hand side of the time range in UTC.
getMinuteEnd(timeZoneId)¶
Number FormTimeRangeField::getMinuteEnd(String timeZoneId)
Description¶
Returns a Number that is the minute on the RIGHT hand side of the time range in specified time zone.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| timeZoneId | String |
getMinuteStart()¶
Number FormTimeRangeField::getMinuteStart()
Description¶
Returns a Number that is the minute on the LEFT hand side of the time range in UTC.
getMinuteStart(timeZoneId)¶
Number FormTimeRangeField::getMinuteStart(String timeZoneId)
Description¶
Returns a Number that is the minute on the LEFT hand side of the time range in specified time zone.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| timeZoneId | String |
getSecondEnd()¶
Number FormTimeRangeField::getSecondEnd()
Description¶
Returns a Number that is the second on the RIGHT hand side of the time range in UTC.
getSecondEnd(timeZoneId)¶
Number FormTimeRangeField::getSecondEnd(String timeZoneId)
Description¶
Returns a Number that is the second on the RIGHT hand side of the time range in specified time zone.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| timeZoneId | String |
getSecondStart()¶
Number FormTimeRangeField::getSecondStart()
Description¶
Returns a Number that is the second on the LEFT hand side of the time range in UTC.
getSecondStart(timeZoneId)¶
Number FormTimeRangeField::getSecondStart(String timeZoneId)
Description¶
Returns a Number that is the second on the LEFT hand side of the time range in specified time zone.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| timeZoneId | String |
setRange(startValue,endValue)¶
Boolean FormTimeRangeField::setRange(Number startValue, Number endValue)
Description¶
Sets the time range's start and end value.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| startValue | Number | |
| endValue | Number |