Class ContextMenu

Hierarchy

ContextMenu

Constructors

constructor

new ContextMenu(): ContextMenu

- Defined in typo3/Build/Sources/TypeScript/backend/Resources/Public/TypeScript/ContextMenu.ts:82
Returns ContextMenu

Properties

Private eventSources

eventSources: Element[] = []

Private mousePos

mousePos: MousePosition = ...

Private record

record: ActiveRecord = ...

Methods

Private drawMenu

drawMenu(items: MenuItems, level: number): string

- Defined in typo3/Build/Sources/TypeScript/backend/Resources/Public/TypeScript/ContextMenu.ts:417
fills the context menu with content and displays it correctly depending on the mouse position

Parameters
- items: MenuItems
  
  The data that will be put in the menu
- level: number
  
  The depth of the context menu
Returns string

Private fetch

fetch(parameters: string): void

- Defined in typo3/Build/Sources/TypeScript/backend/Resources/Public/TypeScript/ContextMenu.ts:188
Make the AJAX request

Parameters
- parameters: string
  
  Parameters sent to the server
Returns void

Private getFirstItem

getFirstItem(item: Element): HTMLElement

- Defined in typo3/Build/Sources/TypeScript/backend/Resources/Public/TypeScript/ContextMenu.ts:338
Parameters
- item: Element
Returns HTMLElement

Private getItemBackward

getItemBackward(element: Element): HTMLElement

- Defined in typo3/Build/Sources/TypeScript/backend/Resources/Public/TypeScript/ContextMenu.ts:319
Returns passed element if it is a menu item, if not checks the previous elements until one is found.

Parameters
- element: Element
Returns HTMLElement

Private getItemForward

getItemForward(item: Element): HTMLElement

- Defined in typo3/Build/Sources/TypeScript/backend/Resources/Public/TypeScript/ContextMenu.ts:330
Returns passed element if it is a menu item, if not checks the previous elements until one is found.

Parameters
- item: Element
Returns HTMLElement

Private getLastItem

getLastItem(item: Element): HTMLElement

- Defined in typo3/Build/Sources/TypeScript/backend/Resources/Public/TypeScript/ContextMenu.ts:342
Parameters
- item: Element
Returns HTMLElement

Private getPosition

getPosition($obj: JQuery, keyboard: boolean): {}

- Defined in typo3/Build/Sources/TypeScript/backend/Resources/Public/TypeScript/ContextMenu.ts:359
Parameters
- $obj: JQuery
- keyboard: boolean
Returns {}
- [key: string]: string

Private hide

hide(obj: string): void

- Defined in typo3/Build/Sources/TypeScript/backend/Resources/Public/TypeScript/ContextMenu.ts:451
Parameters
- obj: string
Returns void

Private hideAll

hideAll(): void

- Defined in typo3/Build/Sources/TypeScript/backend/Resources/Public/TypeScript/ContextMenu.ts:462
Hides all context menus

Returns void

Private initializeContextMenuContainer

initializeContextMenuContainer(): void

- Defined in typo3/Build/Sources/TypeScript/backend/Resources/Public/TypeScript/ContextMenu.ts:146
Manipulates the DOM to add the divs needed for context menu at the bottom of the -tag

Returns void

Private openSubmenu

openSubmenu(level: number, $item: JQuery, keyboard: boolean): void

- Defined in typo3/Build/Sources/TypeScript/backend/Resources/Public/TypeScript/ContextMenu.ts:351
Parameters
- level: number
- $item: JQuery
- keyboard: boolean
Returns void

Private populateData

populateData(items: MenuItems, level: number): void

- Defined in typo3/Build/Sources/TypeScript/backend/Resources/Public/TypeScript/ContextMenu.ts:205
Fills the context menu with content and displays it correctly depending on the mouse position

Parameters
- items: MenuItems
  
  The data that will be put in the menu
- level: number
  
  The depth of the context menu
Returns void

Private setFocusToFirstItem

setFocusToFirstItem(currentItem: HTMLElement): void

- Defined in typo3/Build/Sources/TypeScript/backend/Resources/Public/TypeScript/ContextMenu.ts:302
Parameters
- currentItem: HTMLElement
Returns void

Private setFocusToLastItem

setFocusToLastItem(currentItem: HTMLElement): void

- Defined in typo3/Build/Sources/TypeScript/backend/Resources/Public/TypeScript/ContextMenu.ts:309
Parameters
- currentItem: HTMLElement
Returns void

Private setFocusToNextItem

setFocusToNextItem(currentItem: HTMLElement): void

- Defined in typo3/Build/Sources/TypeScript/backend/Resources/Public/TypeScript/ContextMenu.ts:294
Parameters
- currentItem: HTMLElement
Returns void

Private setFocusToPreviousItem

setFocusToPreviousItem(currentItem: HTMLElement): void

- Defined in typo3/Build/Sources/TypeScript/backend/Resources/Public/TypeScript/ContextMenu.ts:286
Parameters
- currentItem: HTMLElement
Returns void

show

show(table: string, uid: string | number, context: string, enDisItems: string, addParams: string, eventSource?: Element): void

- Defined in typo3/Build/Sources/TypeScript/backend/Resources/Public/TypeScript/ContextMenu.ts:115
Main function, called from most context menu links

Parameters
- table: string
  
  Table from where info should be fetched
- uid: string | number
  
  The UID of the item
- context: string
  
  Context of the item
- enDisItems: string
  
  Items to disable / enable
- addParams: string
  
  Additional params
- eventSource: Element = null
  
  Source Element
Returns void

Private storeMousePositionEvent

storeMousePositionEvent(event: MouseEvent): void

- Defined in typo3/Build/Sources/TypeScript/backend/Resources/Public/TypeScript/ContextMenu.ts:444
event handler function that saves the actual position of the mouse in the context menu object

Parameters
- event: MouseEvent
Returns void

Static Private drawActionItem

drawActionItem(item: MenuItem): string

- Defined in typo3/Build/Sources/TypeScript/backend/Resources/Public/TypeScript/ContextMenu.ts:59
Parameters
- item: MenuItem
Returns string

Static Private within

within(element: HTMLElement, x: number, y: number): boolean

- Defined in typo3/Build/Sources/TypeScript/backend/Resources/Public/TypeScript/ContextMenu.ts:72
Parameters
- element: HTMLElement
- x: number
- y: number
Returns boolean

Generated using TypeDoc