Class Licenses

A license viewer

Hierarchy

SplitPanel
- Licenses

Constructors

constructor

new Licenses(options: Licenses.IOptions): Licenses
Parameters
- options: Licenses.IOptions
Returns Licenses
Overrides SplitPanel.constructor
- Defined in packages/apputils/src/licenses.tsx:29

Properties

`Protected`_bundles

_bundles: TabBar<Widget>

Tabs reflecting available bundles

`Protected`_filters

_filters: Filters

Filters on visible licenses

`Protected`_grid

_grid: Grid

A grid of the current bundle's packages' license metadata

`Protected`_leftPanel

_leftPanel: Panel

An area for selecting licenses by bundle and filters

`Protected`_licenseText

_licenseText: FullText

The currently-selected package's full license text

`Readonly`model

model: Licenses.Model

`Readonly`node

node: HTMLElement

Get the DOM node owned by the widget.

Accessors

alignment

get alignment(): Alignment
Get the content alignment for the split panel.

Notes
This is the alignment of the widgets in the layout direction.

The alignment has no effect if the widgets can expand to fill the entire split panel.

Returns Alignment
Inherited from SplitPanel.alignment
- Defined in node_modules/@lumino/widgets/types/splitpanel.d.ts:40
set alignment(value: Alignment): void
Set the content alignment for the split panel.

Notes
This is the alignment of the widgets in the layout direction.

The alignment has no effect if the widgets can expand to fill the entire split panel.
Parameters
- value: Alignment
Returns void
Inherited from SplitPanel.alignment
- Defined in node_modules/@lumino/widgets/types/splitpanel.d.ts:50

dataset

get dataset(): DOMStringMap
The dataset for the widget's DOM node.

Returns DOMStringMap
Inherited from SplitPanel.dataset
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:88

disposed

get disposed(): ISignal<this, void>
A signal emitted when the widget is disposed.

Returns ISignal<this, void>
Inherited from SplitPanel.disposed
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:33

handleMoved

get handleMoved(): ISignal<this, void>
A signal emitted when a split handle has moved.

Returns ISignal<this, void>
Inherited from SplitPanel.handleMoved
- Defined in node_modules/@lumino/widgets/types/splitpanel.d.ts:66

handles

get handles(): readonly HTMLDivElement[]
A read-only array of the split handles in the panel.

Returns readonly HTMLDivElement[]
Inherited from SplitPanel.handles
- Defined in node_modules/@lumino/widgets/types/splitpanel.d.ts:70

hiddenMode

get hiddenMode(): HiddenMode
Get the method for hiding the widget.

Returns HiddenMode
Inherited from SplitPanel.hiddenMode
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:92
set hiddenMode(value: HiddenMode): void
Set the method for hiding the widget.
Parameters
- value: HiddenMode
Returns void
Inherited from SplitPanel.hiddenMode
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:96

id

get id(): string
Get the id of the widget's DOM node.

Returns string
Inherited from SplitPanel.id
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:80
set id(value: string): void
Set the id of the widget's DOM node.
Parameters
- value: string
Returns void
Inherited from SplitPanel.id
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:84

isAttached

get isAttached(): boolean
Test whether the widget's node is attached to the DOM.

Returns boolean
Inherited from SplitPanel.isAttached
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:45

isDisposed

get isDisposed(): boolean
Test whether the widget has been disposed.

Returns boolean
Inherited from SplitPanel.isDisposed
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:41

isHidden

get isHidden(): boolean
Test whether the widget is explicitly hidden.

Notes
You should prefer !{@link isVisible} over {@link isHidden} if you want to know if the widget is hidden as this does not test if the widget is hidden because one of its ancestors is hidden.

Returns boolean
Inherited from SplitPanel.isHidden
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:53

isVisible

get isVisible(): boolean
Test whether the widget is visible.

Notes
A widget is visible when it is attached to the DOM, is not explicitly hidden, and has no explicitly hidden ancestors.

Since 2.7.0, this does not rely on the Widget.Flag.IsVisible flag. It recursively checks the visibility of all parent widgets.

Returns boolean
Inherited from SplitPanel.isVisible
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:64

layout

get layout(): null | Layout
Get the layout for the widget.

Returns null | Layout
Inherited from SplitPanel.layout
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:116
set layout(value: null | Layout): void
Set the layout for the widget.

Notes
The layout is single-use only. It cannot be changed after the first assignment.

The layout is disposed automatically when the widget is disposed.
Parameters
- value: null | Layout
Returns void
Inherited from SplitPanel.layout
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:126

orientation

get orientation(): Orientation
Get the layout orientation for the split panel.

Returns Orientation
Inherited from SplitPanel.orientation
- Defined in node_modules/@lumino/widgets/types/splitpanel.d.ts:26
set orientation(value: Orientation): void
Set the layout orientation for the split panel.
Parameters
- value: Orientation
Returns void
Inherited from SplitPanel.orientation
- Defined in node_modules/@lumino/widgets/types/splitpanel.d.ts:30

parent

get parent(): null | Widget
Get the parent of the widget.

Returns null | Widget
Inherited from SplitPanel.parent
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:100
set parent(value: null | Widget): void
Set the parent of the widget.

Notes
Children are typically added to a widget by using a layout, which means user code will not normally set the parent widget directly.

The widget will be automatically removed from its old parent.

This is a no-op if there is no effective parent change.
Parameters
- value: null | Widget
Returns void
Inherited from SplitPanel.parent
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:112

renderer

get renderer(): IRenderer
The renderer used by the split panel.

Returns IRenderer
Inherited from SplitPanel.renderer
- Defined in node_modules/@lumino/widgets/types/splitpanel.d.ts:62

spacing

get spacing(): number
Get the inter-element spacing for the split panel.

Returns number
Inherited from SplitPanel.spacing
- Defined in node_modules/@lumino/widgets/types/splitpanel.d.ts:54
set spacing(value: number): void
Set the inter-element spacing for the split panel.
Parameters
- value: number
Returns void
Inherited from SplitPanel.spacing
- Defined in node_modules/@lumino/widgets/types/splitpanel.d.ts:58

title

get title(): Title<Widget>
The title object for the widget.

Notes
The title object is used by some container widgets when displaying the widget alongside some title, such as a tab panel or side bar.

Since not all widgets will use the title, it is created on demand.

The owner property of the title is set to this widget.

Returns Title<Widget>
Inherited from SplitPanel.title
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:76

widgets

get widgets(): readonly Widget[]
A read-only array of the widgets in the panel.

Returns readonly Widget[]
Inherited from SplitPanel.widgets
- Defined in node_modules/@lumino/widgets/types/panel.d.ts:23

Methods

`Protected`_updateBundles

_updateBundles(): void
Update the bundle tabs.

Returns void
- Defined in packages/apputils/src/licenses.tsx:121

activate

activate(): void
Post an 'activate-request' message to the widget.

Notes
This is a simple convenience method for posting the message.

Returns void
Inherited from SplitPanel.activate
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:211

addClass

addClass(name: string): void
Add a class name to the widget's DOM node.
Parameters
- name: string
  The class name to add to the node.
  
  Notes
  If the class name is already added to the node, this is a no-op.
  
  The class name must not contain whitespace.
Returns void
Inherited from SplitPanel.addClass
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:164

addWidget

addWidget(widget: Widget): void
Add a widget to the end of the panel.
Parameters
- widget: Widget
  The widget to add to the panel.
  
  Notes
  If the widget is already contained in the panel, it will be moved.
Returns void
Inherited from SplitPanel.addWidget
- Defined in node_modules/@lumino/widgets/types/panel.d.ts:32

children

children(): IterableIterator<Widget>
Create an iterator over the widget's children.

Returns IterableIterator<Widget>
A new iterator over the children of the widget.

Notes
The widget must have a populated layout in order to have children.

If a layout is not installed, the returned iterator will be empty.
Inherited from SplitPanel.children
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:137

clearFlag

clearFlag(flag: Flag): void
Clear the given widget flag.

Notes
This will not typically be called directly by user code.

Since 2.7.0, Widget.Flag.IsVisible is deprecated. It will be removed in a future version.
Parameters
- flag: Flag
Returns void
Inherited from SplitPanel.clearFlag
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:275

close

close(): void
Send a 'close-request' message to the widget.

Notes
This is a simple convenience method for sending the message.

Returns void
Inherited from SplitPanel.close
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:218

contains

contains(widget: Widget): boolean
Test whether a widget is a descendant of this widget.
Parameters
- widget: Widget
  The descendant widget of interest.
Returns boolean
true if the widget is a descendant, false otherwise.
Inherited from SplitPanel.contains
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:145

dispose

dispose(): void
Handle disposing of the widget

Returns void
Overrides SplitPanel.dispose
- Defined in packages/apputils/src/licenses.tsx:48

fit

fit(): void
Post a 'fit-request' message to the widget.

Notes
This is a simple convenience method for posting the message.

Returns void
Inherited from SplitPanel.fit
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:204

handleEvent

handleEvent(event: Event): void
Handle the DOM events for the split panel.
Parameters
- event: Event
  The DOM event sent to the panel.
  
  Notes
  This method implements the DOM EventListener interface and is called in response to events on the panel's DOM node. It should not be called directly by user code.
Returns void
Inherited from SplitPanel.handleEvent
- Defined in node_modules/@lumino/widgets/types/splitpanel.d.ts:106

hasClass

hasClass(name: string): boolean
Test whether the widget's DOM node has the given class name.
Parameters
- name: string
  The class name of interest.
Returns boolean
true if the node has the class, false otherwise.
Inherited from SplitPanel.hasClass
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:153

hide

hide(): void
Hide the widget and make it hidden to its parent widget.

Notes
This causes the isHidden property to be true.

If the widget is explicitly hidden, this is a no-op.

Returns void
Inherited from SplitPanel.hide
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:236

`Protected`initBundles

initBundles(): void
Initialize the listing of available bundles

Returns void
- Defined in packages/apputils/src/licenses.tsx:79

`Protected`initFilters

initFilters(): void
Initialize the filters

Returns void
- Defined in packages/apputils/src/licenses.tsx:70

`Protected`initGrid

initGrid(): void
Initialize the listing of packages within the current bundle

Returns void
- Defined in packages/apputils/src/licenses.tsx:94

`Protected`initLeftPanel

initLeftPanel(): void
Initialize the left area for filters and bundles

Returns void
- Defined in packages/apputils/src/licenses.tsx:60

`Protected`initLicenseText

initLicenseText(): void
Initialize the full text of the current package

Returns void
- Defined in packages/apputils/src/licenses.tsx:103

insertWidget

insertWidget(index: number, widget: Widget): void
Insert a widget at the specified index.
Parameters
- index: number
  The index at which to insert the widget.
- widget: Widget
  The widget to insert into to the panel.
  
  Notes
  If the widget is already contained in the panel, it will be moved.
Returns void
Inherited from SplitPanel.insertWidget
- Defined in node_modules/@lumino/widgets/types/panel.d.ts:43

`Protected`notifyLayout

notifyLayout(msg: Message): void
Invoke the message processing routine of the widget's layout.
Parameters
- msg: Message
  The message to dispatch to the layout.
  
  Notes
  This is a no-op if the widget does not have a layout.
  
  This will not typically be called directly by user code.
Returns void
Inherited from SplitPanel.notifyLayout
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:295

`Protected`onActivateRequest

onActivateRequest(msg: Message): void
A message handler invoked on an 'activate-request' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from SplitPanel.onActivateRequest
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:330

`Protected`onAfterAttach

onAfterAttach(msg: Message): void
A message handler invoked on an 'after-attach' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from SplitPanel.onAfterAttach
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:372

`Protected`onAfterDetach

onAfterDetach(msg: Message): void
A message handler invoked on an 'after-detach' message.
Parameters
- msg: Message
Returns void
Inherited from SplitPanel.onAfterDetach
- Defined in node_modules/@lumino/widgets/types/splitpanel.d.ts:114

`Protected`onAfterHide

onAfterHide(msg: Message): void
A message handler invoked on an 'after-hide' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from SplitPanel.onAfterHide
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:358

`Protected`onAfterShow

onAfterShow(msg: Message): void
A message handler invoked on an 'after-show' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from SplitPanel.onAfterShow
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:344

`Protected`onBeforeAttach

onBeforeAttach(msg: Message): void
A message handler invoked on a 'before-attach' message.
Parameters
- msg: Message
Returns void
Inherited from SplitPanel.onBeforeAttach
- Defined in node_modules/@lumino/widgets/types/splitpanel.d.ts:110

`Protected`onBeforeDetach

onBeforeDetach(msg: Message): void
A message handler invoked on a 'before-detach' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from SplitPanel.onBeforeDetach
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:379

`Protected`onBeforeHide

onBeforeHide(msg: Message): void
A message handler invoked on a 'before-hide' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from SplitPanel.onBeforeHide
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:351

`Protected`onBeforeShow

onBeforeShow(msg: Message): void
A message handler invoked on a 'before-show' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from SplitPanel.onBeforeShow
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:337

`Protected`onBundleSelected

onBundleSelected(): void
Event handler for updating the model with the current bundle

Returns void
- Defined in packages/apputils/src/licenses.tsx:112

`Protected`onChildAdded

onChildAdded(msg: ChildMessage): void
A message handler invoked on a 'child-added' message.
Parameters
- msg: ChildMessage
Returns void
Inherited from SplitPanel.onChildAdded
- Defined in node_modules/@lumino/widgets/types/splitpanel.d.ts:118

`Protected`onChildRemoved

onChildRemoved(msg: ChildMessage): void
A message handler invoked on a 'child-removed' message.
Parameters
- msg: ChildMessage
Returns void
Inherited from SplitPanel.onChildRemoved
- Defined in node_modules/@lumino/widgets/types/splitpanel.d.ts:122

`Protected`onCloseRequest

onCloseRequest(msg: Message): void
A message handler invoked on a 'close-request' message.

Notes
The default implementation unparents or detaches the widget.
Parameters
- msg: Message
Returns void
Inherited from SplitPanel.onCloseRequest
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:302

`Protected`onFitRequest

onFitRequest(msg: Message): void
A message handler invoked on a 'fit-request' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from SplitPanel.onFitRequest
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:323

`Protected`onResize

onResize(msg: ResizeMessage): void
A message handler invoked on a 'resize' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: ResizeMessage
Returns void
Inherited from SplitPanel.onResize
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:309

`Protected`onUpdateRequest

onUpdateRequest(msg: Message): void
A message handler invoked on an 'update-request' message.

Notes
The default implementation of this handler is a no-op.
Parameters
- msg: Message
Returns void
Inherited from SplitPanel.onUpdateRequest
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:316

processMessage

processMessage(msg: Message): void
Process a message sent to the widget.
Parameters
- msg: Message
  The message sent to the widget.
  
  Notes
  Subclasses may reimplement this method as needed.
Returns void
Inherited from SplitPanel.processMessage
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:284

relativeSizes

relativeSizes(): number[]
Get the relative sizes of the widgets in the panel.

Returns number[]
A new array of the relative sizes of the widgets.

Notes
The returned sizes reflect the sizes of the widgets normalized relative to their siblings.

This method does not measure the DOM nodes.
Inherited from SplitPanel.relativeSizes
- Defined in node_modules/@lumino/widgets/types/splitpanel.d.ts:82

removeClass

removeClass(name: string): void
Remove a class name from the widget's DOM node.
Parameters
- name: string
  The class name to remove from the node.
  
  Notes
  If the class name is not yet added to the node, this is a no-op.
  
  The class name must not contain whitespace.
Returns void
Inherited from SplitPanel.removeClass
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:175

setFlag

setFlag(flag: Flag): void
Set the given widget flag.

Notes
This will not typically be called directly by user code.

Since 2.7.0, Widget.Flag.IsVisible is deprecated. It will be removed in a future version.
Parameters
- flag: Flag
Returns void
Inherited from SplitPanel.setFlag
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:265

setHidden

setHidden(hidden: boolean): void
Show or hide the widget according to a boolean value.
Parameters
- hidden: boolean
  true to hide the widget, or false to show it.
  
  Notes
  This is a convenience method for hide() and show().
Returns void
Inherited from SplitPanel.setHidden
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:245

setRelativeSizes

setRelativeSizes(sizes: number[], update?: boolean): void
Set the relative sizes for the widgets in the panel.
Parameters
- sizes: number[]
  The relative sizes for the widgets in the panel.
- Optionalupdate: boolean
  Update the layout after setting relative sizes. Default is True.
  
  Notes
  Extra values are ignored, too few will yield an undefined layout.
  
  The actual geometry of the DOM nodes is updated asynchronously.
Returns void
Inherited from SplitPanel.setRelativeSizes
- Defined in node_modules/@lumino/widgets/types/splitpanel.d.ts:95

show

show(): void
Show the widget and make it visible to its parent widget.

Notes
This causes the isHidden property to be false.

If the widget is not explicitly hidden, this is a no-op.

Returns void
Inherited from SplitPanel.show
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:227

testFlag

testFlag(flag: Flag): boolean
Test whether the given widget flag is set.

Notes
This will not typically be called directly by user code.

Since 2.7.0, Widget.Flag.IsVisible is deprecated. It will be removed in a future version.
Parameters
- flag: Flag
Returns boolean
Inherited from SplitPanel.testFlag
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:255

toggleClass

toggleClass(name: string, force?: boolean): boolean
Toggle a class name on the widget's DOM node.
Parameters
- name: string
  The class name to toggle on the node.
- Optionalforce: boolean
  Whether to force add the class (true) or force remove the class (false). If not provided, the presence of the class will be toggled from its current state.
Returns boolean
true if the class is now present, false otherwise.

Notes
The class name must not contain whitespace.
Inherited from SplitPanel.toggleClass
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:190

update

update(): void
Post an 'update-request' message to the widget.

Notes
This is a simple convenience method for posting the message.

Returns void
Inherited from SplitPanel.update
- Defined in node_modules/@lumino/widgets/types/widget.d.ts:197

Class Licenses

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Licenses

Properties

Protected_bundles

Protected_filters

Protected_grid

Protected_leftPanel

Protected_licenseText

Readonlymodel

Readonlynode

Accessors

alignment

Notes

Returns Alignment

Notes

Parameters

Returns void

dataset

Returns DOMStringMap

disposed

Returns ISignal<this, void>

handleMoved

Returns ISignal<this, void>

handles

Returns readonly HTMLDivElement[]

hiddenMode

Returns HiddenMode

Parameters

Returns void

id

Returns string

Parameters

Returns void

isAttached

Returns boolean

isDisposed

Returns boolean

isHidden

Notes

Returns boolean

isVisible

Notes

Returns boolean

layout

Returns null | Layout

Notes

Parameters

Returns void

orientation

Returns Orientation

Parameters

Returns void

parent

Returns null | Widget

Notes

Parameters

Returns void

renderer

Returns IRenderer

spacing

Returns number

Parameters

Returns void

title

Notes

Returns Title<Widget>

widgets

Returns readonly Widget[]

Methods

Protected_updateBundles

Returns void

`Protected`_bundles

`Protected`_filters

`Protected`_grid

`Protected`_leftPanel

`Protected`_licenseText

`Readonly`model

`Readonly`node

`Protected`_updateBundles

`Protected`initBundles

`Protected`initFilters

`Protected`initGrid

`Protected`initLeftPanel

`Protected`initLicenseText

`Protected`notifyLayout

`Protected`onActivateRequest

`Protected`onAfterAttach

`Protected`onAfterDetach

`Protected`onAfterHide