LayoutItem Class
File
c1.nav.js
Module
c1.nav
Base Class
DisposableObject
Derived Classes
Group, Tile

Defines the base class for the layoutitem. Now there are two kinds of layoutitems: Tile and Group.

Constructor

constructor

constructor(opts?: any): LayoutItem

Initializes a new LayoutItem.

Parameters
  • opts: any Optional

    JavaScript object containing initialization data for the layoutitem.

Returns
LayoutItem

Properties

hostElement

Gets the outest element which represents this layoutitem.

Type
HTMLElement

layout

Gets the layout which owns this item.

Type
LayoutBase

parent

Gets the parent which owns this layoutitem.

It could be a Group or a LayoutBase.

Type
any

Methods

addEventListener

addEventListener(target: EventTarget, type: string, fn: any, capture?: boolean): void

Adds an event listener to an element owned by this Control.

The control keeps a list of attached listeners and their handlers, making it easier to remove them when the control is disposed (see the dispose and removeEventListener methods).

Failing to remove event listeners may cause memory leaks.

Parameters
  • target: EventTarget

    Target element for the event.

  • type: string

    String that specifies the event.

  • fn: any

    Function to execute when the event occurs.

  • capture: boolean Optional

    Whether the listener is capturing.

Inherited From
DisposableObject
Returns
void

dispose

dispose(fullDispose?: boolean): void

Disposes the object.

Parameters
  • fullDispose: boolean Optional

    A boolean value decides wehter to keep the current status when disposing. If true, all the current status will be cleared. Otherwise, keep the current status.

Returns
void

draw

draw(): void

Draws the layout item.

Adds the codes to implement the paiting parts.

Returns
void

initialize

initialize(options: any): void

Initializes the object by copying the properties from a given object.

Parameters
  • options: any

    Object that contains the initialization data.

Returns
void

remove

remove(): boolean

Removes the current layoutitem from its parent.

Returns
boolean

removeEventListener

removeEventListener(target?: EventTarget, type?: string, fn?: any, capture?: boolean): number

Removes one or more event listeners attached to elements owned by this Control.

Parameters
  • target: EventTarget Optional

    Target element for the event. If null, removes listeners attached to all targets.

  • type: string Optional

    String that specifies the event. If null, removes listeners attached to all events.

  • fn: any Optional

    Handler to remove. If null, removes all handlers.

  • capture: boolean Optional

    Whether the listener is capturing. If null, removes capturing and non-capturing listeners.

Inherited From
DisposableObject
Returns
number

render

render(container?: HTMLElement): HTMLElement

Renders the layoutitem in the specified container.

Parameters
  • container: HTMLElement Optional

    the container element where the layoutitem renders in.

Returns
HTMLElement