Interface IBalloon

Defines the interface for OutSystemsUI Balloon Pattern

Export

Interface

IBalloon

Hierarchy-Diagram

UML class diagram of IBalloon

Legend

icon for a class in the UML class diagram

class

icon for an interface in the UML class diagram

interface

icon for a public property in the UML class diagram

public property

icon for a private property in the UML class diagram

private property

icon for a public method in the UML class diagram

public method

icon for a private method in the UML class diagram

private method

Hierarchy

IFeature
IOpenable
- IBalloon

Implemented by

Balloon

Index

Methods

open setBalloonShape updatePositionOption dispose close

Properties

Methods

open

open(isOpenedByApi?: boolean, arrowKeyPressed?: ArrowDown | ArrowUp): void
Overload the open method.

Memberof
IBalloon
Parameters
- Optional isOpenedByApi: boolean
- Optional arrowKeyPressed: ArrowDown | ArrowUp
Returns void
Overrides IOpenable.open
- Defined in OSFramework/OSUI/Feature/Balloon/IBalloon.ts:19

setBalloonShape

setBalloonShape(shape?: OSFramework.OSUI.GlobalEnum.ShapeTypes): void
Method to set the Balloon border shape

Memberof
IBalloon
Parameters
- Optional shape: OSFramework.OSUI.GlobalEnum.ShapeTypes
Returns void
- Defined in OSFramework/OSUI/Feature/Balloon/IBalloon.ts:30

updatePositionOption

updatePositionOption(position: OSFramework.OSUI.GlobalEnum.FloatingPosition): void
Method to update the Balloon position

Memberof
IBalloon
Parameters
- position: OSFramework.OSUI.GlobalEnum.FloatingPosition
Returns void
- Defined in OSFramework/OSUI/Feature/Balloon/IBalloon.ts:38

dispose

dispose(): void
Dispose object and free up its used resources

Memberof
OSFramework.Interface.IDisposable

Returns void
Inherited from IFeature.dispose
- Defined in OSFramework/OSUI/Interface/IDisposable.ts:15

close

close(): void
Method signature to close the pattern.

Memberof
OSFramework.Interface.IOpenable

Returns void
Inherited from IOpenable.close
- Defined in OSFramework/OSUI/Interface/IOpenable.ts:16

Properties

`Optional` isOpen

isOpen?: boolean