File

src/components/kendoUI/listview/details/listview-details.component.ts

Extends

ListViewBaseComponent

Implements

OnInit DoCheck

Metadata

Index

Properties
Methods
Inputs
Outputs
Accessors

Constructor

constructor(service1: WebMapService, changeDetector1: ChangeDetectorRef, renderer1: Renderer2, element1: ElementRef, webComponents1: WebComponentsService, bringTopServ1: BringTopService, containerInteraction2?: ContainerInteractionService)
Parameters :
Name Type Optional
service1 WebMapService No
changeDetector1 ChangeDetectorRef No
renderer1 Renderer2 No
element1 ElementRef No
webComponents1 WebComponentsService No
bringTopServ1 BringTopService No
containerInteraction2 ContainerInteractionService Yes

Inputs

dataUrl
Type : string
class
Type : string
model
Type : any
tabindex
Type : string
tooltip
Type : string
useCss
Type : boolean
Default value : false

Property to know if the inline styles should not be applied.

Outputs

DoubleClick
Type : EventEmitter<EventData>
ItemActive
Type : EventEmitter<EventData>
ItemCheck
Type : EventEmitter<EventData>
ItemClick
Type : EventEmitter<EventData>
ItemSelectionChanged
Type : EventEmitter<EventData>
SelectedIndexChanged
Type : EventEmitter<EventData>
ContextMenu
Type : EventEmitter<EventData>
DragDrop
Type : EventEmitter<EventData>
Enter
Type : EventEmitter<EventData>
GotFocus
Type : EventEmitter<EventData>
KeyDown
Type : EventEmitter<KeyEventArgs>
KeyPress
Type : EventEmitter<EventData>
KeyUp
Type : EventEmitter<KeyEventArgs>
Leave
Type : EventEmitter<EventData>
LostFocus
Type : EventEmitter<EventData>
MouseMove
Type : EventEmitter<MouseEventArgs>
Resize
Type : EventEmitter<EventData>
TextChanged
Type : EventEmitter<EventData>
Validated
Type : EventEmitter<EventData>
Validating
Type : EventEmitter<EventData>

Methods

fetchItems
fetchItems()

Fetchs items

Returns : void
fetchItemsInternal
fetchItemsInternal(data: any[], dataArray: any[], imageUrlsArray: any[])
Parameters :
Name Type Optional
data any[] No
dataArray any[] No
imageUrlsArray any[] No
Returns : void
getChecked
getChecked(dataItem: any)

Gets checked

Parameters :
Name Type Optional
dataItem any No
Returns : boolean

true if checked

gridLinesStyle
gridLinesStyle()

Function to support the "Gridlines" property that hides or shows the grid lines in the "listview".

Returns : string

{string}

hoverSelectionMechanism
hoverSelectionMechanism(event: MouseEvent, rowIndex: number, columnIndex: number)

This manage the hover on the cells

Parameters :
Name Type Optional
event MouseEvent No
rowIndex number No
columnIndex number No
Returns : void
iconStyle
iconStyle(rowIndex: number)

Returns the icon for the treenode

Parameters :
Name Type Optional Description
rowIndex number No

the index of the item

Returns : any
iconStyleSize
iconStyleSize()

Sets the treeNode icon dimension

Returns : void
isValidIcon
isValidIcon(columnIndex: number)

Returns the icon for the listviewitem

Parameters :
Name Type Optional Description
columnIndex number No

the columnIndex of the cell

Returns : boolean
itemClickHandler
itemClickHandler(event: any, rowIndex?: number)

Item click handler

Parameters :
Name Type Optional
event any No
rowIndex number Yes
Returns : void
loadColumns
loadColumns()

Get the listview's Columns object

Returns : void
loadGroups
loadGroups()

Get the listview's Groups object

Returns : void
ngOnInit
ngOnInit()
Returns : void
rowClassValidation
rowClassValidation(context: RowClassArgs)

Validate row property to assing a specific class

Parameters :
Name Type Optional
context RowClassArgs No
Returns : string

header class assing to tr

selectOnHover
selectOnHover(event: MouseEvent, rowIndex: number, columnIndex: number)

Method to manage the hover depending on the ctrlKey

Parameters :
Name Type Optional
event MouseEvent No
rowIndex number No
columnIndex number No
Returns : void
triggerDoubleClickEvents
triggerDoubleClickEvents(event: MouseEvent, rowIndex: number, columnIndex: number)

Triggers the events associated with the doubleClick. Events: ItemCheck, itemActivate and doubleClick.

Parameters :
Name Type Optional
event MouseEvent No
rowIndex number No
columnIndex number No
Returns : void
updateSelectedIndices
updateSelectedIndices()
Returns : void
click
click(event: any)
Decorators :
@serverEvent('Enter')

click event

Parameters :
Name Type Optional
event any No
Returns : void
detectChanges
detectChanges()
Returns : void
doubleClick
doubleClick(eventData: any)
Decorators :
@serverEvent('DoubleClick')

doubleClick event

Parameters :
Name Type Optional
eventData any No
Returns : void
getCheckedIndex
getCheckedIndex(event: any)

Get the index from cheked event.

Parameters :
Name Type Optional
event any No
Returns : number

the event index

getCheckedIndices
getCheckedIndices(event: any, checked: boolean)
Parameters :
Name Type Optional
event any No
checked boolean No
Returns : void
getGroupHeader
getGroupHeader(groupKey)

Method which receives the key that corresponds to a group and returns the header of the group

Parameters :
Name Optional
groupKey No
Returns : string
getIdByCheckedIndex
getIdByCheckedIndex(index: number)

Get the item by index

Parameters :
Name Type Optional
index number No
Returns : string

DataTransferObject with the item

Static getItemByIndexCheck
getItemByIndexCheck(event: any, component: ListViewBaseComponent)
Parameters :
Name Type Optional
event any No
component ListViewBaseComponent No
Returns : any
Static getItemByIndexClick
getItemByIndexClick(event: any, component: ListViewBaseComponent)
Parameters :
Name Type Optional
event any No
component ListViewBaseComponent No
Returns : any
getParams
getParams(event: any)

Set the params for the api call in ItemCheck

Parameters :
Name Type Optional
event any No
Returns : HttpParams

The HttpParams for the api call

getPointerClass
getPointerClass()

Returns the pointer cursor class if the listview has oneClick activation.

Returns : string

{string}

getSelectedIndices
getSelectedIndices(obj: any)

Retrieve an array SelectedIndices

Parameters :
Name Type Optional
obj any No
Returns : void
hasHotTrackingAndSelected
hasHotTrackingAndSelected(rowIndex: number)

Method to determine if a row should show the text as hyperlink with underline

Parameters :
Name Type Optional
rowIndex number No
Returns : any

{*}

hasOneClickItemActivation
hasOneClickItemActivation(eventData: any)

Verifies if the activation has the oneClick validations correctly.

Parameters :
Name Type Optional
eventData any No
Returns : boolean

{boolean}

hasStandardItemActivation
hasStandardItemActivation(event: any)

Verifies if the activation has the standard validations correctly.

Parameters :
Name Type Optional
event any No
Returns : boolean

{boolean}

isRowSelected
isRowSelected(e: RowArgs)

Determines whether row selected is

Parameters :
Name Type Optional
e RowArgs No
Returns : boolean

true if row selected

itemActivationHandler
itemActivationHandler(event: any, rowIndex: number, isFromDblCLick)

Handles the ItemActivate event validations.

Parameters :
Name Type Optional Default value
event any No
rowIndex number No
isFromDblCLick No false
Returns : void
itemActive
itemActive(event: any, rowIndex: number)
Decorators :
@serverEvent('ItemActivate')

itemActive event

Parameters :
Name Type Optional
event any No
rowIndex number No
Returns : void
itemCheck
itemCheck(event: any, rowIndex: number)
Decorators :
@serverEvent('ItemCheck', ListViewBaseComponent.getItemByIndexCheck)
Parameters :
Name Type Optional
event any No
rowIndex number No
Returns : void
itemClick
itemClick(event: EventData)
Decorators :
@serverEvent('ListViewItemClickAction', ListViewBaseComponent.getItemByIndexClick)
Parameters :
Name Type Optional
event EventData No
Returns : void
itemSelectionChanged
itemSelectionChanged(event: any)
Decorators :
@serverEvent('ItemSelectionChanged')
Parameters :
Name Type Optional
event any No
Returns : void
ngDoCheck
ngDoCheck()
Returns : void
selectedIndexChanged
selectedIndexChanged(event: any)
Decorators :
@serverEvent('SelectedIndexChanged')

selectedIndexChanged event

Parameters :
Name Type Optional
event any No
Returns : any

index changed

Private addModifierKey
addModifierKey(keyCode: number)

Add a modifier key if it applies.

Parameters :
Name Type Optional
keyCode number No
Returns : void
applyAnchorProperty
applyAnchorProperty()

Applies anchor property

Returns : void
applyAutoSizeProperty
applyAutoSizeProperty()

Applies auto size property Fix the current control dimensions to fit its content according to the autosize and autosizemode properties

Returns : void
applyFocus
applyFocus()

Applies focus to input or selectable element in component. It triggers dom element focus()

Returns : void
blur
blur(event: any)
Decorators :
@serverEvent('LostFocus')
Parameters :
Name Type Optional
event any No
Returns : void
bringToFront
bringToFront()

Bring to the front the current control.

Returns : void
Private bringToFrontService
bringToFrontService()

Bring to front service

Returns : void
Protected calculateTabOrder
calculateTabOrder()

Calculates tab order according to model value and TabStop

Returns : any

tab order

canSubscribeToErrorProvider
canSubscribeToErrorProvider()

Returns true if the control is ready to subscribe to the ErroProvider.

Returns : boolean
change
change(event: any)
Decorators :
@serverEvent('TextChanged')
Parameters :
Name Type Optional
event any No
Returns : void
changeChildEnableStatus
changeChildEnableStatus(parent: any, value: boolean)

Property EnabledInternal: is used to check the original enabled state of any control. IMPORTANT: This property is modify only when the component is modified by himself its parent can't modify it

Parameters :
Name Type Optional
parent any No
value boolean No
Returns : void
checkDetectChangesAfterLeave
checkDetectChangesAfterLeave()

Over ride if the component need to check for changes after losses focus

Returns : void
checkErrorProvider
checkErrorProvider()

This function handles the ErrorProvider for each component

Returns : void
contextMenu
contextMenu(event: any)
Parameters :
Name Type Optional
event any No
Returns : void
createErrorProvider
createErrorProvider()

Auxiliary function that creates the image of the errorProvider, this to reduce the cognitive complexity of the function checkErrorProvider

Returns : void
currentWebMapService
currentWebMapService()

Current instance of the static WebMapService

Returns : WebMapService

{*}

Protected detectChangesExecution
detectChangesExecution()

This function should be overridden on the components that need the detectChanges() function to be called on the subscription of the detect changes

Returns : void
detectChangesSubscribe
detectChangesSubscribe()

Each component that have the isForm as true should implement this method

Returns : void
dragDrop
dragDrop(event: any)
Decorators :
@serverEvent('DragDrop', ControlComponent.dragDropEventArgsExtractor)

Handles the dragdrop event. Should stop server propagation if allowdrop is false;

Parameters :
Name Type Optional Description
event any No

the drop data

Returns : boolean
Static dragDropEventArgsExtractor
dragDropEventArgsExtractor(event: any, component: ControlComponent)
Parameters :
Name Type Optional
event any No
component ControlComponent No
Returns : any
enter
enter(event: any)
Decorators :
@serverEvent('Enter', ControlComponent.EnterEventArgsExtractor, undefined)
Parameters :
Name Type Optional
event any No
Returns : void
Static EnterEventArgsExtractor
EnterEventArgsExtractor(event: any, component: ControlComponent)
Parameters :
Name Type Optional
event any No
component ControlComponent No
Returns : any
errorValueAux
errorValueAux()

Auxiliary function that returns values in some especial cases, this to reduce the cognitive complexity of the function checkErrorProvider

Returns : number
focus
focus(event: any)
Decorators :
@serverEvent('GotFocus')
Parameters :
Name Type Optional
event any No
Returns : void
getElementErrorProvider
getElementErrorProvider(element)

Get the corresponding element depending of the TagName

Parameters :
Name Optional Description
element No

The current element

Returns : HTMLElement
getElementErrorProviderStyle
getElementErrorProviderStyle(element)

Get the corresponding Style depending of the TagName

Parameters :
Name Optional Description
element No

The current element

Returns : string
getElementsWidth
getElementsWidth()

Calculate the total width, including all siblings elements.

Returns : number
getExtraElement
getExtraElement()

Gets the extra element affecting the position of the error provider.

Returns : any
Protected getNewPositions
getNewPositions()

Gets new positions Analyze the children components and get the new sizes for this control with the autoSizeMode

Returns : literal type

new positions

getStyle
getStyle()

Gets the new Style

Returns : Style
getStyleDisplay
getStyleDisplay()

Method to allow each component to manage its own display property Example : {display: 'block'}

Returns : string
getType
getType()

Gets string indicating the type

Returns : string

type

getWrapperElement
getWrapperElement()

Gets the wrapper element of the control in the DOM.

Returns : any
Private hideToolTipDirective
hideToolTipDirective()

Hides tool tip directive

Returns : void
isBindedEvent
isBindedEvent(event: string)

Indicates if an event is binded in the server or not.

Parameters :
Name Type Optional Description
event string No

The name of the event in the server.

Returns : boolean
isComponentReady
isComponentReady()

Determines whether component is ready in the DOM

Returns : boolean

true if component ready

Protected isCustomControl
isCustomControl()

Check if this control is a custom editor for the c1flexgrid component. otherwise it returns False.

Returns : boolean

Returns True if the control is within a custom editor column, otherwise it returns False.

isUserControl
isUserControl()

Gets if is usercontrol or not

Returns : boolean
keyDown
keyDown(event: any)
Decorators :
@serverEvent('KeyDown', ControlComponent.keyEventArgsExtractor)
Parameters :
Name Type Optional
event any No
Returns : void
Static keyEditEventArgsExtractor
keyEditEventArgsExtractor(event: any, component: ControlComponent)
Parameters :
Name Type Optional
event any No
component ControlComponent No
Returns : any
Static keyEventArgsExtractor
keyEventArgsExtractor(event: any, component: ControlComponent)
Parameters :
Name Type Optional
event any No
component ControlComponent No
Returns : any
keyPress
keyPress(event: any)
Decorators :
@serverEvent('KeyPress', ControlComponent.keyPressEventArgsExtractor)
Parameters :
Name Type Optional
event any No
Returns : void
Static keyPressEventArgsExtractor
keyPressEventArgsExtractor(event: any, component: ControlComponent)
Parameters :
Name Type Optional Description
event any No

event to call

component ControlComponent No

component used to get the id.

Returns : any
keyUp
keyUp(event: any)
Decorators :
@serverEvent('KeyUp', ControlComponent.keyEventArgsExtractor)
Parameters :
Name Type Optional
event any No
Returns : void
leave
leave(event: any)
Decorators :
@serverEvent('Leave')
Parameters :
Name Type Optional
event any No
Returns : void
leaveEventsHandler
leaveEventsHandler(event: any)

Triggers the leave-validating-validated events in the correct order.

Parameters :
Name Type Optional
event any No
Returns : void
markForCheck
markForCheck()

Marks for check Marks component to be checked by the next detect changes action

Returns : void
mouseEnter
mouseEnter(event: any)

Mouses enter Shows tooltip if need it

Parameters :
Name Type Optional Description
event any No

the current js event object

Returns : void
mouseLeave
mouseLeave(event: any)

Mouses leave Hides tooltip if need it

Parameters :
Name Type Optional Description
event any No

the current js event object

Returns : void
mouseMove
mouseMove(event: any)

MouseMove event emit the data for every mouseMove event

Parameters :
Name Type Optional
event any No
Returns : void
ngAfterViewChecked
ngAfterViewChecked()
Returns : void
ngAfterViewInit
ngAfterViewInit()
Returns : void
ngOnDestroy
ngOnDestroy()
Returns : void
notifyErrorProvider
notifyErrorProvider()

Auxiliary function notifying that the errorProvider has been rendered, this to reduce the cognitive complexity of the function checkErrorProvider

Returns : void
notifyEvent
notifyEvent(eventName: string, event: any)

Notifies leave

Parameters :
Name Type Optional Description
eventName string No
event any No

the current event

Returns : void
Protected notifyParentAutoSize
notifyParentAutoSize()

Notifies parent auto size

Returns : void
notifyWindowToBringTop
notifyWindowToBringTop(event: any)

Notifies the window to bring top When a control is clicked or focused in the screen

Parameters :
Name Type Optional Description
event any No

The current javascript event

Returns : void
processSpecialDock
processSpecialDock(component: ControlComponent, size: ISize, offsets: IOffsets)

Process special dock for the current Control. you should override the method in the specify control.

Parameters :
Name Type Optional Description
component ControlComponent No

child component

size ISize No

parentSize

offsets IOffsets No
Returns : literal type

special dock. new size and offset for the dock context.

Private removeModifierKey
removeModifierKey(keyCode: number)

Remove a modifier key if it applies.

Parameters :
Name Type Optional
keyCode number No
Returns : void
Private removeStyleProperty
removeStyleProperty(property: string)

Sets style property Updates model values for Style

Parameters :
Name Type Optional Description
property string No

current property to update

Returns : void
resize
resize(event: any)
Decorators :
@serverEvent('Resize')

Trigger the event resize defined through the output member.

Parameters :
Name Type Optional Description
event any No

The event object.

Returns : void
resolvePendingTabSubscriptions
resolvePendingTabSubscriptions()

Resolves pending tab subscriptions for components that were resolved as pending parent

Returns : void
Protected setChildIndex
setChildIndex()

Sets child index to HTML zindex property

Returns : void
setDisplayElementOriginalDimensions
setDisplayElementOriginalDimensions()

Sets display element original dimensions

Returns : void
setMyStyle
setMyStyle()

Returns a valid style object to be applied according to the styling information set in the control's model

Returns : literal type
shouldApplyFocus
shouldApplyFocus()

Determines whether applyFocus method should be called.

Returns : boolean

true if apply focus

Private shouldValidateErrorProvider
shouldValidateErrorProvider()

Determines if error provider should be validated

Returns : boolean

true if it has to validate error provider

Private showTooltipDirective
showTooltipDirective()

Shows tooltip directive

Returns : void
specialStyle
specialStyle()

Specials style. Override this method if you want to handle special style for the dock

Returns : void

style

Private startAnchorProcess
startAnchorProcess()

Starts anchor process After rendering a new window the anchor process is triggered before the docking process to ensure that the measure to edges are correct and the anchor distances are calculated properly

Returns : void
subscribeErrorProvider
subscribeErrorProvider()

This function handles the subscription to the ErrorProvider.

Returns : void
Private tooltipHandler
tooltipHandler()

Tooltips handler

Returns : void
Protected updateDockProperty
updateDockProperty()

compare if the dock is different and call the dockChange

Returns : void
validated
validated(event: any)
Decorators :
@serverEvent('Validated')
Parameters :
Name Type Optional
event any No
Returns : void
validating
validating(event: any)
Decorators :
@serverEvent('Validating')
Parameters :
Name Type Optional
event any No
Returns : void
verifyErrorProvider
verifyErrorProvider(event: EventData)

Function that verifies that another component does not duplicate the same errorProvider

Parameters :
Name Type Optional
event EventData No
Returns : void

Properties

checkedInxInternalObj
Type : any
Default value : {}
checkItemUrl
Default value : `${this.defaultDataUrl}/CheckItem`
columns
Type : any[]
defaultDataUrl
Type : string
Default value : 'api/listview'
fetchItemsUrl
Default value : `${this.defaultDataUrl}/FetchItems`
focusedItemUrl
Default value : `${this.defaultDataUrl}/FocusItem`
getColumnsUrl
Default value : `${this.defaultDataUrl}/GetColumns`

Url to get the listview's Columns set

getGroupsUrl
Default value : `${this.defaultDataUrl}/GetGroups`

Url to get the listview's Groups set

GroupingColumnName
Type : string
Default value : 'MobilizeLVGrouping'
groups
Type : GroupDescriptor[]
Default value : [{ field: this.GroupingColumnName }]

property used to store the grouping definition used by the kendogrid

groupsData
Type : any[]
iconHeight
Type : any
iconWidth
Type : any
imageUrls
Type : any[]
items
Type : DataResult | DataTransferObject[]
itemsId
Type : DataTransferObject[]
Static listViewMapperId
Type : string
Default value : 'lstVw'
loadingData
Type : any

Flag that indicates whether the grid is loading data or not

selIdxInternalObj
Type : any
Default value : {}
Private _font
Type : Font
_model
Type : any
controlFlag
Default value : true

The controlFlag help us to avoid twice calls.

detectChangesSubscription
Type : string

Detect changes subscription of control component

displayElementInner
Type : HTMLElement | undefined

the element that is shown in the DOM. Should be override in each component.

Private Static DIV_TAG
Type : string
Default value : 'DIV'
errorIsRendered
Default value : false

This flag lets the controller know if the error provider has been rendered.

errorIsShowed
Default value : false

This flag allows the controller to display the errorProvider.

hasErrorProviderSubscription
Default value : false

Flag indicating whether the control has the error provider subscription.

isControlComponent
Default value : true

Validate the component inherits from controlComponent or is an instance of controlComponent

isInsideGridCell
Type : boolean

This should be set from the container where the component is going to be rendered Determines whether the component is render dynamically inside a grid cell(using a container mechanism like wm-container)

Static modifierKeys
Default value : Keys.none
originalHeight
Type : number

Original height of control component

originalVisibility
Type : boolean

Original visibility of control component Keeps a record of the current visible value to detect changes;

originalWidth
Type : number

Original width of control component

registerManually
Default value : false

A reference for managing component registration manually

shortcut
Type : string

Shortcut property of basecontrolcomponent

showUnderline
Default value : false

Property to trigger the underline of the shortcuts

style
Type : Style

This object contains the style information for the component.

syncCompleteSubscription
Type : string

Sync complete subscription of control component

tabDirective
Type : ControlsDirective
Decorators :
@ViewChild(ControlsDirective, {static: false})

View child of tab directive

tooltipDir
Type : TooltipDirective
Decorators :
@ViewChild(TooltipDirective)

View child of control component

triggerShortcutUnderlineSubscription
Type : Subscription

Shortcut underline subcription of a component

afterFirstCall
Default value : false

After first call of control component. Flag used to know if the control have been called in the ngAfterViewInit

anchorApplied
Default value : -1

Anchor applied of control component Holds the currently applied anchor property -1 otherwise.

autoSizeApplied
Default value : false

Auto size applied of control component

children
Type : []
Default value : []

Controls of control component Array of controls that are children of this component

containerTabOrderService
Type : ContainerTabOrderService

Container tab order service of control component base component

currentAutoSizeMode
Default value : -1

Current auto size mode of control component

currentDock
Type : number
Default value : 0

Current dock of control component

currentDockingOrder
Type : []
Default value : []

Current docking order of control component. Array of children ids

customControl
Default value : false

Custom control property obtains the value when is calculated in ngAfterViewInit, it determines if it is a component rendered inside of a custom control column of WFNETC1 WE SHOULD TRY TO REMOVE THIS PROPERTY, WINFORMS COMPONENTS SHOULD NOT KNOW THAT A COMPONENT FROM WFNETC1 EXISTS.

defaultControls
Type : []
Default value : []

Default controls of control component. Internal array of the child with special docking

errorProviderIconWasCreated
Type : boolean

Flag to know if the error provider icon is created.

internalTabOrder
Type : any

Internal tab order of control component base component

isApplyingFocus
Type : boolean

Optional flag to determine when the component is calling the applyFocus method.

lastErrorProviderMessage
Default value : undefined

Last error provider message of control component base component to cached value and avoid multiple unnecessary function calls

lastZIndex
Type : number
Default value : 0

Last zIndex of control component

originalTooltipText
Type : string

Original tooltip text of control component base component

specialDock
Default value : false

Special dock of control component. Mark to process the dock with special values

tabNodeReference
Type : TabNode

Tab node reference of base control component

tooltipDisplayed
Type : boolean

Tooltip displayed of control component base component

Accessors

itemData
getitemData()
setitemData(value: any)
Parameters :
Name Type Optional
value any No
Returns : void
Legend
Html element
Component
Html element with directive

results matching ""

    No results matching ""