Class Rating

Defines the interface for OutSystemsUI Patterns

Hierarchy-Diagram

Legend

class

abstract class

interface

public property

protected property

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

AbstractPattern<RatingConfig>
- Rating

Implements

IRating

Index

Properties

`Protected` isProviderBased

isProviderBased: boolean = false

`Private` _clonedPlaceholders

_clonedPlaceholders: string

`Private` _decimalValue

_decimalValue: number

`Private` _disabled

_disabled: boolean

`Private` _eventOnRatingClick

_eventOnRatingClick: Generic

`Private` _eventOnRatingInputKeyup

_eventOnRatingInputKeyup: Generic

`Private` _isHalfValue

_isHalfValue: boolean

`Private` _platformEventOnSelect

_platformEventOnSelect: OSGeneric

`Private` _ratingFieldsetElem

_ratingFieldsetElem: HTMLElement

`Private` _ratingIconStatesElem

_ratingIconStatesElem: HTMLElement

`Private` _ratingInputName

_ratingInputName: string

Methods

`Protected` finishBuild

finishBuild(): void
Protected
Marks the built as being finished.

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Inherited from AbstractPattern.finishBuild
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:61

`Protected` triggerPlatformEventCallback

triggerPlatformEventCallback(platFormCallback: OSGeneric, ...args: unknown[]): void
Protected
Triggers a generic platform event.

Memberof
AbstractProviderPattern
Parameters
- platFormCallback: OSGeneric
- Rest ...args: unknown[]
Returns void
Inherited from AbstractPattern.triggerPlatformEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:81

`Protected` triggerPlatformInitializedEventCallback

triggerPlatformInitializedEventCallback(): void
Protected
Trigger the Initialized callback platform event.

Memberof
AbstractPattern

Returns void
Inherited from AbstractPattern.triggerPlatformInitializedEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:93

`Protected` unsetGlobalCallbacks

unsetGlobalCallbacks(): void
Protected
Unsets the global callbacks. This naming is used to prevent overriding the unsetCallback method on all patterns

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Inherited from AbstractPattern.unsetGlobalCallbacks
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:107

equalsToID

equalsToID(patternId: string): boolean
Enables to uniquely identify the pattern in all ways.

Returns
{boolean}

Memberof
OSFramework.Patterns.AbstractPattern
Parameters
- patternId: string
Returns boolean
Implementation of IRating.equalsToID

Inherited from AbstractPattern.equalsToID
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:172

`Private` _createItems

_createItems(): void
Private
Method that will iterate on the RatingScale, to crate an item for each one

Memberof
Rating

Returns void
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:38

`Private` _getDecimalValue

_getDecimalValue(value: number): number
Private
Method to get the rating decimal value

Returns
{number}

Memberof
Rating
Parameters
- value: number
Returns number
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:63

`Private` _getIsHalfValue

_getIsHalfValue(value: number): boolean
Private
Method to get if the valie is-half

Returns
{boolean}

Memberof
Rating
Parameters
- value: number
Returns boolean
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:75

`Private` _getValue

_getValue(): number
Private
Method to get the rating value

Returns
{number}

Memberof
Rating

Returns number
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:89

`Private` _handlePlaceholders

_handlePlaceholders(): void
Private
Method that handles the placeholders content storage and DOM lifecycle

Memberof
Rating

Returns void
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:100

`Private` _ratingInputOnKeyup

_ratingInputOnKeyup(e: KeyboardEvent): void
Private
Method used to set the keyboard keydown event

Memberof
Rating
Parameters
- e: KeyboardEvent
  
  event
Returns void
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:115

`Private` _ratingOnClick

_ratingOnClick(e: MouseEvent): void
Private
Method that handles the click event and set the new value, by checking the input:checked

Memberof
Rating
Parameters
- e: MouseEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:138

`Private` _renderItem

_renderItem(index: number): void
Private
Method called on createItems() to render the correct HTML structure for each item

Memberof
Rating
Parameters
- index: number
Returns void
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:167

`Private` _setEvents

_setEvents(): void
Private
Method that will add the needed events

Memberof
Rating

Returns void
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:193

`Private` _setFieldsetDisabledStatus

_setFieldsetDisabledStatus(isDisabled: boolean): void
Private
Method to toggle fieldset disbaled status

Memberof
Rating
Parameters
- isDisabled: boolean
Returns void
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:210

`Private` _setInitialCssClasses

_setInitialCssClasses(): void
Private
Method to set the cssClasses that should be assigned to the element on it's initialization

Memberof
Rating

Returns void
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:233

`Private` _setInitialPropertiesValues

_setInitialPropertiesValues(): void
Private
Method to set the initial and local properties values

Memberof
Rating

Returns void
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:256

`Private` _setIsDisabled

_setIsDisabled(isDisabled: boolean): void
Private
Method to set disabled status

Memberof
Rating
Parameters
- isDisabled: boolean
Returns void
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:267

`Private` _setIsEdit

_setIsEdit(): void
Private
Method to set the IsEdit option

Memberof
Rating

Returns void
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:284

`Private` _setScale

_setScale(): void
Private
Method to set a RatingScale - The amout of stars pattern will have

Memberof
Rating

Returns void
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:306

`Private` _setSize

_setSize(oldSize: string): void
Private
Method to set the Rating Size

Memberof
Rating
Parameters
- oldSize: string
Returns void
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:322

`Private` _setValue

_setValue(triggerEvent??: boolean): void
Private
Method to set a rating value

Returns
{void}

Memberof
Rating
Parameters
- Optional triggerEvent: boolean = false
Returns void
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:342

`Private` _toggleRatingInputsEvents

_toggleRatingInputsEvents(add: boolean): void
Private
Method used to manage the Rating inputs events, they will be only set when IsEdit=False
- This is needed in order to grant keyboard behaves like ckick, in order to avoid user be able to select any star by using keyboard navigation when IsEdit=False!
Memberof
Rating
Parameters
- add: boolean
  
  Flag to indicates if events should be added or removed.
Returns void
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:413

`Private` _triggerOnSelectEvent

_triggerOnSelectEvent(value: number): void
Private
Method that triggers the OnSelect event

Memberof
Rating
Parameters
- value: number
Returns void
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:433

`Private` _unsetEvents

_unsetEvents(): void
Private
Method to remove the event listeners

Memberof
Rating

Returns void
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:445

`Protected` setA11YProperties

setA11YProperties(): void
Protected
This method has no implementation on this pattern context!

Memberof
OSFramework.Patterns.Rating.Rating

Returns void
Overrides AbstractPattern.setA11YProperties
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:460

`Protected` setCallbacks

setCallbacks(): void
Protected
Method to set the events

Memberof
OSFramework.Patterns.Rating.Rating

Returns void
Overrides AbstractPattern.setCallbacks
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:470

`Protected` setHtmlElements

setHtmlElements(): void
Protected
Method to set the html references that will be used to manage the cssClasses and atribute properties

Memberof
OSFramework.Patterns.Rating.Rating

Returns void
Overrides AbstractPattern.setHtmlElements
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:481

`Protected` unsetCallbacks

unsetCallbacks(): void
Protected
Method to remove all assigned callbacks

Memberof
OSFramework.Patterns.Rating.Rating

Returns void
Overrides AbstractPattern.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:492

`Protected` unsetHtmlElements

unsetHtmlElements(): void
Protected
Method to unset the HTML elements

Memberof
OSFramework.Patterns.Rating.Rating

Returns void
Overrides AbstractPattern.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:503

build

build(): void
Method to build the Rating

Memberof
OSFramework.Patterns.Rating.Rating

Returns void
Implementation of IRating.build

Overrides AbstractPattern.build
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:516

changeProperty

changeProperty(propertyName: string, propertyValue: unknown): void
Method to update value when a parameters changed occurs

Memberof
OSFramework.Patterns.Rating.Rating
Parameters
- propertyName: string
- propertyValue: unknown
Returns void
Implementation of IRating.changeProperty

Overrides AbstractPattern.changeProperty
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:545

disable

disable(): void
Method to set the Rating as disabled

Memberof
Rating

Returns void
Implementation of IRating.disable
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:578

dispose

dispose(): void
Method to destroy the Rating pattern

Memberof
OSFramework.Patterns.Rating.Rating

Returns void
Implementation of IRating.dispose

Overrides AbstractPattern.dispose
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:587

enable

enable(): void
Method to set the Rating as enabled

Memberof
Rating

Returns void
Implementation of IRating.enable
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:601

registerCallback

registerCallback(eventName: string, callback: OSGeneric): void
Method to register a given callback event handler.

Memberof
OSFramework.Patterns.Rating.Rating
Parameters
- eventName: string
- callback: OSGeneric
Returns void
Implementation of IRating.registerCallback

Overrides AbstractPattern.registerCallback
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:612

Accessors

`Protected` _enableAccessibility

get _enableAccessibility(): boolean
Protected
Getter that allows to obtain the accessibility is enabled.

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Inherited from AbstractPattern._enableAccessibility
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:207

selfElement

get selfElement(): HTMLElement
Getter that allows to obtain the self element.

Memberof
OSFramework.Patterns.AbstractPattern

Returns HTMLElement
Implementation of IRating.selfElement

Inherited from AbstractPattern.selfElement
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:218

isBuilt

get isBuilt(): boolean
Getter that tells if the pattern is already built.

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Implementation of IRating.isBuilt

Inherited from AbstractPattern.isBuilt
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:229

configs

get configs(): C
Current configurations/state of the pattern.

Memberof
OSFramework.Patterns.AbstractPattern

Returns C
Inherited from AbstractPattern.configs
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:240

uniqueId

get uniqueId(): string
Unique id of the pattern. Internal use only.

Memberof
OSFramework.Patterns.AbstractPattern

Returns string
Implementation of IRating.uniqueId

Inherited from AbstractPattern.uniqueId
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:251

widgetId

get widgetId(): string
Id of the pattern known by the developer. External use only.

Memberof
OSFramework.Patterns.AbstractPattern

Returns string
Implementation of IRating.widgetId

Inherited from AbstractPattern.widgetId
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:262

Constructors

constructor

new Rating(uniqueId: string, configs: JSON): OSFramework.OSUI.Patterns.Rating.Rating
Parameters
- uniqueId: string
- configs: JSON
Returns OSFramework.OSUI.Patterns.Rating.Rating
Overrides AbstractPattern.constructor
- Defined in OSFramework/OSUI/Pattern/Rating/Rating.ts:28

Class Rating

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Properties

Methods

Accessors

Constructors

Properties

Protected isProviderBased

Private _clonedPlaceholders

Private _decimalValue

Private _disabled

Private _eventOnRatingClick

Private _eventOnRatingInputKeyup

Private _isHalfValue

Private _platformEventOnSelect

Private _ratingFieldsetElem

Private _ratingIconStatesElem

Private _ratingInputName

Methods

Protected finishBuild

Memberof

Returns void

Protected triggerPlatformEventCallback

Memberof

Parameters

platFormCallback: OSGeneric

Rest ...args: unknown[]

Returns void

Protected triggerPlatformInitializedEventCallback

Memberof

Returns void

Protected unsetGlobalCallbacks

Memberof

Returns void

equalsToID

Returns

Memberof

Parameters

patternId: string

Returns boolean

Private _createItems

Memberof

Returns void

Private _getDecimalValue

Returns

Memberof

Parameters

value: number

Returns number

Private _getIsHalfValue

Returns

Memberof

Parameters

value: number

Returns boolean

Private _getValue

Returns

Memberof

Returns number

Private _handlePlaceholders

Memberof

Returns void

Private _ratingInputOnKeyup

Memberof

Parameters

e: KeyboardEvent

Returns void

Private _ratingOnClick

Memberof

Parameters

e: MouseEvent

Returns void

Private _renderItem

Memberof

Parameters

index: number

`Protected` isProviderBased

`Private` _clonedPlaceholders

`Private` _decimalValue

`Private` _disabled

`Private` _eventOnRatingClick

`Private` _eventOnRatingInputKeyup

`Private` _isHalfValue

`Private` _platformEventOnSelect

`Private` _ratingFieldsetElem

`Private` _ratingIconStatesElem

`Private` _ratingInputName

`Protected` finishBuild

`Protected` triggerPlatformEventCallback

`Rest` ...args: unknown[]

`Protected` triggerPlatformInitializedEventCallback

`Protected` unsetGlobalCallbacks

`Private` _createItems

`Private` _getDecimalValue

`Private` _getIsHalfValue

`Private` _getValue

`Private` _handlePlaceholders

`Private` _ratingInputOnKeyup

`Private` _ratingOnClick

`Private` _renderItem

`Private` _setEvents

`Private` _setFieldsetDisabledStatus

`Private` _setInitialCssClasses

`Private` _setInitialPropertiesValues

`Private` _setIsDisabled

`Private` _setIsEdit

`Private` _setScale

`Private` _setSize

`Private` _setValue

`Optional` triggerEvent: boolean = false

`Private` _toggleRatingInputsEvents

`Private` _triggerOnSelectEvent

`Private` _unsetEvents

`Protected` setA11YProperties

`Protected` setCallbacks

`Protected` setHtmlElements

`Protected` unsetCallbacks

`Protected` unsetHtmlElements