Class MenuItem

The MenuItem class is a single item in a menu and typically utilized to display text and icon.

Hierarchy

Constructors

  • Constructs a menu item of the specified type with the given text, image and parent.

    Parameters

    • Optional parent: Menu
    • Optional text: string
    • Optional image: string

    Returns MenuItem

Properties

m_children: Widget[] = []
m_content: Widget
m_dom: HTMLElement
m_icon: Icon
m_parent: Widget
m_spacer: Spacer
m_text: Text

Accessors

  • get alignment(): Alignment
  • Returns the alignment along the main axis.

    Returns Alignment

  • set alignment(alignment): void
  • Sets the alignment along the main axis to the given alignment.

    Parameters

    Returns void

  • get blocked(): boolean
  • Returns true if events are blocked; otherwise returns false.

    Returns boolean

  • set blocked(blocked): void
  • If blocked is true, then events emitted by this event watcher will be blocked, meaning that emitting an event will not trigger any callback functions that are bound to it.

    Parameters

    • blocked: boolean

    Returns void

  • get checked(): boolean
  • Returns the check state of this menu item.

    Returns boolean

  • set checked(checked): void
  • Sets the check state of this menu item to checked.

    Parameters

    • checked: boolean

    Returns void

  • get children(): readonly Widget[]
  • Returns the list of children.

    Returns readonly Widget[]

  • set css(style): void
  • Sets the style of this widget. See also id addClass.

    Parameters

    Returns void

  • get dom(): HTMLElement
  • Returns the native DOM of this widget, user can directly manipulate the native DOM.

    Returns HTMLElement

  • get enabled(): boolean
  • Returns whether this widget or its parent chain is enabled or not. By default, the value of this property is true.

    Returns boolean

  • set enabled(enabled): void
  • Sets whether this widget is enabled or not. Disabling a widget implicitly disables all its children, it is not possible to explicitly enable a child widget while its parent widget remains disabled.

    Parameters

    • enabled: boolean

    Returns void

  • get height(): number
  • Returns the height of this widget.

    Returns number

  • set height(height): void
  • Sets the height of this widget to the given height.

    Parameters

    • height: number

      The unit of height is px.

    Returns void

  • get id(): string
  • Returns the id of this widget.

    Returns string

  • set id(id): void
  • Set the id of this widget to the given id. The id is utilized to set the style of the widget. See also css

    Parameters

    • id: string

    Returns void

  • get image(): string
  • Returns the image of this menu item.

    Returns string

  • set image(image): void
  • Sets the image of this menu item to image.

    Parameters

    • image: string

    Returns void

  • get left(): number
  • Returns the left coordinate of this widget within its parent widget.

    Returns number

  • set left(left): void
  • Sets the left coordinate of this widget within its parent widget.

    Parameters

    • left: number

      The unit of left is px.

    Returns void

  • get orientation(): Orientation
  • Returns the orientation of this flex layout.

    Returns Orientation

  • set orientation(orientation): void
  • Sets the orientation of this flex layout to the given orientation.

    Parameters

    Returns void

  • get parent(): Widget
  • Returns the parent of this widget, or undefined if it does not have any parent widget.

    Returns Widget

  • set parent(parent): void
  • Sets the parent of the widget to the given parent. If the new parent widget is the old parent widget, this function does nothing.

    Parameters

    Returns void

  • get position(): Point
  • Returns the position of this widget within its parent widget.

    Returns Point

  • set position(position): void
  • Sets the position of this widget to the given position.

    Parameters

    • position: Point

      The unit of position is px.

    Returns void

  • get rect(): Rect
  • Returns the rect of this widget within the desktop.

    Returns Rect

  • get shortcutKey(): string
  • Returns the shortcut key sequence shown on this menu item.

    Returns string

  • set shortcutKey(key): void
  • Sets the shortcut key sequence of this menu item to key, such as "Ctrl+X".

    Parameters

    • key: string

    Returns void

  • get size(): Size
  • Returns the size of this widget.

    Returns Size

  • set size(size): void
  • Sets the size of this widget to the given size. If the size is Size(0, 0) will cause the widget to not appear on screen.

    Parameters

    • size: Size

      The unit of size is px.

    Returns void

  • get spacing(): number
  • Returns the spacing between widgets inside this flex layout.

    Returns number

  • set spacing(spacing): void
  • Set the spacing to the given pacing.

    Parameters

    • spacing: number

    Returns void

  • get style(): CSSStyleDeclaration
  • Returns the style of this widget.

    Returns CSSStyleDeclaration

  • get text(): string
  • Returns the text of this menu item.

    Returns string

  • set text(text): void
  • Sets the text of this menu item to text.

    Parameters

    • text: string

    Returns void

  • get tooltip(): string
  • Returns the tooltip of this widget. When the mouse hovers over the widget for a period of time(it can be set by Tooltip::WakeUpDelay), a message will automatically pop up, and it will disappear automatically when the mouse moves away. By default, the value of this property is an empty string.

    Returns string

  • set tooltip(tooltip): void
  • Sets the tooltip of this widget to the given tooltip.

    Parameters

    • tooltip: string

    Returns void

  • get top(): number
  • Returns the top coordinate of this widget within its parent widget.

    Returns number

  • set top(top): void
  • Sets the top coordinate of this widget to the given top.

    Parameters

    • top: number

      The unit of top is px.

    Returns void

  • get visible(): boolean
  • Returns whether this widget or its parent chain is visible or not. By default, the value of this property is true.

    Returns boolean

  • set visible(visible): void
  • Sets whether this widget is visible or not. If an ancestor widget is not visible, the widget won't become visible until all its ancestors are visible.

    Parameters

    • visible: boolean

    Returns void

  • get width(): number
  • Returns the width of this widget.

    Returns number

  • set width(width): void
  • Sets the width of this widget to the given width.

    Parameters

    • width: number

      The unit of width is px.

    Returns void

  • get sender(): EventWatcher
  • Returns the object that sent the event.

    Returns EventWatcher

Methods

  • Adds the attribute of this widget. The attribute is utilized to set the style. See also css

    Parameters

    • attr: string

    Returns void

  • Adds the class name of this widget. The class name is utilized to set the style. See also css. All widgets with the same class name use the same style.

    Parameters

    • className: string

    Returns void

  • Returns void

  • Adds a callback function that's going to be called when the event is emitted.

    Type Parameters

    Parameters

    • name: K
    • callback: ((...data) => void)
        • (...data): void
        • Parameters

          Returns void

    Returns void

  • Parameters

    • name: string
    • callback: ((...data) => void)
        • (...data): void
        • Parameters

          • Rest ...data: any[]

          Returns void

    Returns void

  • Clears all widgets in the list of children.

    Returns void

  • Closes this widget. This function is equivalent to setting this widget's parent to undefined. If the widget has no resources to free, call this function directly.

    Returns void

  • Returns void

  • Delegates this event watcher to handle the given watcher's event named name.

    Type Parameters

    Parameters

    Returns void

  • Parameters

    Returns void

  • Destroys the widget, all the widget's children are destroyed first. The widget is destroyed when it's parent is destroyed. When the widget is destroyed, make sure to release all resources, such as timers, etc. Releases the resources in the protected function free(), and the system will call this function automatically when the parent widget or itself is destroyed. See also free.

    Returns void

  • Returns void

  • Emits an arbitrary set of arguments to the callback function which is bound to the event named name.

    Type Parameters

    Parameters

    Returns boolean

  • Parameters

    • name: string
    • Rest ...data: any[]

    Returns boolean

  • Returns void

  • Frees the resources.See also destroy.

    Returns void

  • Returns whether this widget contains the attribute.

    Parameters

    • attr: string

    Returns boolean

  • Returns whether this widget contains the class name.

    Parameters

    • className: string

    Returns boolean

  • Hides the widget and its child widgets. This function is equivalent to setting the visible property to false.

    Returns void

  • Inserts the child widget at index in the list of children.

    Parameters

    Returns void

  • Raises this widget to the front of the parent widget's children. The display order of this widget is determined by the order in which they appear in the parent widget's children.

    Returns boolean

  • Removes the attribute of this widget.

    Parameters

    • attr: string

    Returns void

  • Removes the class name of this widget.

    Parameters

    • className: string

    Returns void

  • Sets whether the widget uses flex layout.

    Parameters

    Returns void

  • Shows the widget and its child widgets. This function is equivalent to setting the visible property to true.

    Returns void

  • If param attr is true, adds the attribute, otherwise removes the attribute.

    Parameters

    • attr: string
    • on: boolean

      true or false

    Returns void

  • If param on is true, adds the class name, otherwise removes the class name.

    Parameters

    • className: string
    • on: boolean

      true or false

    Returns void

  • Removes the specified watcher for the event named name.

    Type Parameters

    Parameters

    • name: K

    Returns void

  • Parameters

    • name: string

    Returns void

Generated using TypeDoc