SmartComponent Library NG
  1. Classes
  2. SmartTab

File

src/ui/mdi/smart-tab.ts

Description

Represents a tab that is displayed by the SmartMdiComponent.

Example

Index

Properties
Methods
Accessors

Constructor

constructor(url: string, config: Route, viewManager: SmartViewManagerService, router: Router, locationStrategy: LocationStrategy, paramMap: any, navigationStack: NavigationStackItem[], id, routeParams: any)
Parameters :
Name Type Optional
url string No
config Route No
viewManager SmartViewManagerService No
router Router No
locationStrategy LocationStrategy No
paramMap any No
navigationStack NavigationStackItem[] No
id No
routeParams any No

Properties

browserUrl
Type : string

The browser URL corresponding to this tab.
closed
Default value : false

Indicates whether this tab has been closed.
compiledRoutePath
Type : string
Default value : ''
Public config
Type : Route
Public customComponent
Type : any
Public id
Default value : UUID.UUID()
location
Type : Location
Public navigationStack
Type : NavigationStackItem[]
Default value : []
Public paramMap
Type : any
Default value : {}
Public routeParams
Type : any
Public url
Type : string

Methods

formLoaded
formLoaded(event: FormReadyEvent)

Called when this tab's form has been loaded. Sets the component ref, updates the navigation history, sets the browser URL and initializes the tab title.

Parameters :
Name Type Optional
event FormReadyEvent No
Returns : void
Public getCompiledRouteUrl
getCompiledRouteUrl(url: string, paramMap: any)
Parameters :
Name Type Optional
url string No
paramMap any No
Returns : string

string
getSerializedInfo
getSerializedInfo()
Returns : string

string
navigate
navigate(url: string, config: Route, paramMap, disableHistory, routeParams: any)

Performs navigation within the context of this tab.

Parameters :
Name Type Optional Default value Description
url string No

the (smart) URL to navigate to
config Route No

the corresponding route configuration
paramMap No

the parameter map to use for the given route configuration
disableHistory No false

if set to true, this navigation will not be pushed to this tab's history stack.
routeParams any No this.routeParams
Returns : void
navigateBack
navigateBack(levels: number)

Navigates the given number of levels up the history stack.

Parameters :
Name Type Optional Default value
levels number No 1
Returns : void
Public setWindowLocation
setWindowLocation(routeParams: any)
Parameters :
Name Type Optional Default value
routeParams any No this.routeParams
Returns : void
updateBrowserTitle
updateBrowserTitle()

Updates the browser title

Returns : void
viewLoaded
viewLoaded(view: ViewRef)
Parameters :
Name Type Optional
view ViewRef No
Returns : void

Accessors

inUpdateMode
getinUpdateMode()

Indicates whether the Smart Form displayed in this tab is in update mode

Returns : boolean
title
gettitle()

The tab's displayed title.

Returns : string
settitle(value: string)
Parameters :
Name Type Optional
value string No
Returns : void
selected
getselected()

Indicates whether the this tab is selected.

Returns : boolean
setselected(value: boolean)
Parameters :
Name Type Optional
value boolean No
Returns : void
componentRef
getcomponentRef()

The ComponentRef displayed by this tab.

Returns : ViewRef
canGoBack
getcanGoBack()

Indicates whether this tab has a navigation history to navigate back through.

Returns : boolean

result-matching ""

    No results matching ""