cpr.controls.TabFolder

TabFolder A control that displays one page selected by the user among multiple pages.
Hierarchy

Index

Events
Event Description
animationend Event that occurs after the animation ends.
animationstart Event that occurs at the start of the animation.
before-context-value-change Use a bind context in a control that has a bind context An event that occurs before the value changes.
before-draw This event is called just before group content is drawn.
before-selection-change Event that occurs before a TabItem is selected.
click An event that occurs when the user clicks the control.
close This event occurs when a tab item is closed, and can be canceled by the user.
context-value-change Use a bind context in a control that has a bind context An event that occurs after the value changes.
contextmenu An event in which the mouse context menu is called.
dblclick An event that occurs when the user double-clicks the control.
dispose The event that is called when the control is dispose.
dragenter When the mouse pointer enters the elements included in the control while dragging Events that occur.
dragleave During the drag, the mouse pointer may have exited the elements contained in the control.
dragover While dragging the source control with the mouse, the mouse pointer An event that occurs when moving within a region.
drop Drag the source control to the target control while dragging the source control with the mouse.
focusin Just before the control and its sub-elements gain focus The event that occurs.
focusout Occurs just before the control's child elements below the control lose focus event.
item-accept An event to check whether a tap item will accept a drop before it is dropped.
item-drag An event that occurs when a tab item starts dragging.
item-drop Event that occurs after the tap item is dropped.
keydown Event raised when the user presses a key.
keyup Event that occurs when the user releases the key.
measure-size Event raised when calculating control size
mousedown When the user presses the mouse button with the pointer over the control Occurs when an event occurs.
mouseenter An event that occurs when the mouse pointer enters the control.
mouseleave If the user moves the mouse pointer beyond the control and its children Events that occur when moving.
mousemove This event is raised when the user moves the pointer over the control.
mouseup The user releases the mouse button while over the control.
selection-change Event that occurs after a TabItem is selected.
tabheader-click Event that occurs when the tab header is clicked.
transitionend Event that fires after CSS property transition ends.
transitionstart Event that fires when CSS property transition starts.
Properties
Name Type Description
accessbility Accessbility Gets the accessibility-related ARIA properties or gets the context in which they can be specified.
childCombinatorClass String Get a class for the combinator to select direct children.
clipContent Boolean Gets whether clipping is applied.
disposed Boolean Returns whether the control should be removed.
editable Boolean Returns whether the value can be changed by user action.
enabled Boolean Returns whether the control is enabled.
fieldLabel String Returns the logical field name of the control.
focusable Boolean Returns whether the control is focusable.
focused Boolean Returns whether the control has focus.
headerArrowPosition TabHeaderArrowPosition TabHeader arrow position setting: both, left, right
headerArrowVisible TabHeaderArrowVisibility Gets a way to determine whether the scroll button in the tab item area is visible.
headerCheckable Boolean Check whether TabItem Header can be checked
headerControl UIControl Get the header control.
headerControlWidth Number
headerPosition TabHeaderPosition Gets the setting for the location where the tab header appears.
hideHeader Boolean Returns whether to show or hide headers.
id String Returns the ID of the control.
itemAlign TabItemAlign Gets a way to sort items.
itemDisplayExp #expression Gets an expression to apply transformations of the tab item's content and style.
itemDraggingMode ItemDraggingMode Gets the drag handling mode of the tab item.
itemSizing TabItemSizing You get a way to determine the width of an item.
itemSpacing Number Gets the gap between items.
name String Returns the name of the control.
preferredItemWidth Number If you use a fixed value for the width of the item, you get the value used for that width.
readOnly Boolean Returns whether a non-modifiable read-only mode is in effect.
showCloseOnlyActive Boolean Returns whether the close button is visible for the active tab only.
style TabFolder$Styler Returns the style settings of the control.
tabIndex Number Returns the control focus order using the Tab Key.
tabsWithAutoSelection Boolean Obtains whether to activate auto-selection when moving a tab item.
tooltip String Returns a description of the control
type ControlType Returns the signature string of the Control's unique Type that can distinguish the Control.
useItemTextEllipsis Boolean Obtains whether to use ellipsis in text when the item has insufficient display space.
uuid String Returns the unique ID of the control.
visible Boolean Returns the style property for controlling css visibility.
Methods
Name Return Type Description
addEventListener Add listeners by EventType to the control.
addEventListenerOnce (e: cpr.events.CEvent)=>Void Add a listener to the control that will run only once per EventType.
addHeaderControl Add a header control.
addTabItem Add a tab item.
bind IBindFactory Bind that property.
blur Removes focus from the control.
close Close the tab item.
closeAll Close all tab items.
closeOthers Closes all TabItems except the selected TabItem.
confirmEvent Boolean Determines whether to run the Control's Default Event Handler depending on the state of the Control.
dispatchEvent Boolean Forwards specific events.
dispose Removes the objects that the control contains.
findParent UIControl Find the parent control.
focus Assigns focus to the control.
focusNext Moves focus to the next control.
focusPrevious Moves focus to the previous control.
getActualRect Rectangle Gets the bounds value of the control relative to the browser's view port.
getAllItemsByName TabItem[] Get items by item name.
getAllRecursiveChildren UIControl[] Recursively gets all child controls contained in this container and all controls contained in subcontainers.
getAllRecusiveChildren UIControl[] Recursively gets all child controls contained in this container and all controls contained in subcontainers.
getAppInstance AppInstance Returns the App to which the control belongs.
getBindContext BindContext Returns the bind context.
getBindInfo BindInfo Returns the bind property information for the control.
getCheckedTabItems TabItem[] Get checked tap items.
getChild UIControl Get the immediate child controls within the container by ID.
getChildren UIControl[] Get all child controls.
getChildrenCount Number Returns the number of child controls.
getFirstChild UIControl Get the first child control.
getHeaderControls UIControl[] Get all the header controls.
getHtmlAttrNames String[] Returns all custom DOM DATA attribute names.
getItemBounds Rectangle Gets the bounds that the given tab item is displaying on the browser viewport.
getItemByName TabItem Get the item by its name.
getItemForContent TabItem Finds and returns a TabItem with the given control as its content.
getItemsDelegate TabItemsDelegate
getLastChild UIControl The last child gets control.
getNextControl UIControl Returns the control to be moved by Tab Key or by the autoskip property.
getOffsetRect Rectangle The area being displayed is obtained based on the parent container to which it belongs.
getParent Container Gets the parent control.
getPrevControl UIControl Shift + Tab Returns the focus to be moved through the key.
getSelectedTabItem TabItem Get the selected tap items.
getTabItemByID TabItem Use the tab item id (unique number) to get the tab item.
getTabItems TabItem[] Get all tap items.
getUserAttrNames String[] Returns all custom attribute names.
getVisualParentControl UIControl Gets the closest parent UI control.
htmlAttr Specifies custom DOM properties.
insertTabItem Insert a tab item.
isAvailableBinding Boolean Returns whether the queried property is bindable and the binding has been configured to obtain a valid value.
isBindable Boolean Make sure it is a bindable property.
isFloated Boolean Returns whether the control is floating through an app instance or a specific container.
isShowing Boolean Returns the status that the screen is showing.
redraw Redraw the control.
removeAllChildren Removes all child controls.
removeAllEventListeners Removes all event listeners for the control.
removeAllHtmlAttr Delete all custom DOM DATA attributes.
removeAllUserAttr Delete all custom attributes.
removeChild Remove the control.
removeEventListener Remove Listener for each EventType in the control.
removeEventListeners Remove all EventType listeners from the control.
removeHeaderControl Remove the header control.
removeHtmlAttr Removes the user-defined DOM DATA attribute for a specific attribute name.
removeTabItem Removes the tab item.
removeUserAttr Removes user-defined attributes for a specific attribute name.
reorderTabItem Change the order of specific tab items.
setBindContext Sets the bind context.
setItemsDelegate Specifies additional behavior related to tab items.
setNextControl Sets the control to be moved by Tab Key or by the autoskip property.
setPrevControl Shift + Tab Set the focus to be moved through the key.
setSelectedTabItem Specifies the selected tab item.
unbind Unbind that property.
userAttr Specifies custom properties.
userData Specifies custom data.
userattr Object Returns a user-defined property.

Constructor

TabFolder(id)
Create a tabbed folder.
Parameters
name type description
idoptional String id of tab folder

Events

animationend
CAnimationEvent Event that occurs after the animation ends.
animationstart
CAnimationEvent Event that occurs at the start of the animation.
before-context-value-change
CValueChangeEvent Use a bind context in a control that has a bind context An event that occurs before the value changes.
before-draw
CUIEvent This event is called just before group content is drawn. It is only used for dynamically constructing internal content.
before-selection-change
CSelectionEvent Event that occurs before a TabItem is selected. Selection-change occurs as the following event. 
oldSelection: {cpr.controls.TabItem} previously selected tab item
newSelection: {cpr.controls.TabItem} Tab item whose selection will be changed
click
CMouseEvent An event that occurs when the user clicks the control.
close
CUIEvent This event occurs when a tab item is closed, and can be canceled by the user. 
content: {cpr.controls.TabItem} Closed tab item
context-value-change
CValueChangeEvent Use a bind context in a control that has a bind context An event that occurs after the value changes.
contextmenu
CMouseEvent An event in which the mouse context menu is called. Context menu is provided only for TabHeader.
To prevent the system's context menu, you need to write event.preventDefault().
event.targetObject.item: {cpr.controls.TabItem | null} Gets the tab item located at the mouse pointer. If not, it is null.
dblclick
CMouseEvent An event that occurs when the user double-clicks the control.
dispose
CEvent The event that is called when the control is dispose.
dragenter
CMouseEvent When the mouse pointer enters the elements included in the control while dragging Events that occur.
dragleave
CMouseEvent During the drag, the mouse pointer may have exited the elements contained in the control. The event that occurs when.
dragover
CMouseEvent While dragging the source control with the mouse, the mouse pointer An event that occurs when moving within a region.
drop
CMouseEvent Drag the source control to the target control while dragging the source control with the mouse. Event that fires when dropping.
focusin
CFocusEvent Just before the control and its sub-elements gain focus The event that occurs.
focusout
CFocusEvent Occurs just before the control's child elements below the control lose focus event.
item-accept
CItemAcceptEvent An event to check whether a tap item will accept a drop before it is dropped.
item-drag
CItemEvent An event that occurs when a tab item starts dragging.
item-drop
CItemEvent Event that occurs after the tap item is dropped.
keydown
CKeyboardEvent Event raised when the user presses a key. Keycode related constants can be referenced at KeyCode.
keyup
CKeyboardEvent Event that occurs when the user releases the key. Keycode related constants can be referenced at KeyCode.
measure-size
CMeasureSizeEvent Event raised when calculating control size
mousedown
CMouseEvent When the user presses the mouse button with the pointer over the control Occurs when an event occurs.
mouseenter
CMouseEvent An event that occurs when the mouse pointer enters the control.
mouseleave
CMouseEvent If the user moves the mouse pointer beyond the control and its children Events that occur when moving.
mousemove
CMouseEvent This event is raised when the user moves the pointer over the control.
mouseup
CMouseEvent The user releases the mouse button while over the control. When an event occurs.
selection-change
CSelectionEvent Event that occurs after a TabItem is selected. 
oldSelection: {cpr.controls.TabItem} previously selected tab item
newSelection: {cpr.controls.TabItem} Tab item whose selection has changed
tabheader-click
CItemEvent Event that occurs when the tab header is clicked. 
item: {cpr.controls.TabItem} Clicked item
transitionend
CTransitionEvent Event that fires after CSS property transition ends.
transitionstart
CTransitionEvent Event that fires when CSS property transition starts.

Properties

accessbility
declaring type UIControl
type Accessbility
readonly
Gets the accessibility-related ARIA properties or gets the context in which they can be specified.
childCombinatorClass
declaring type Container
type String
get
Get a class for the combinator to select direct children.
set
Specifies the class for the combinator to select immediate children.
clipContent
declaring type Container
type Boolean
get
Gets whether clipping is applied.
set
Specifies whether clipping is applied when child controls leave the area of ​​this container. If you have a layout configured to display scroll bars, this property is ignored.
disposed
declaring type Control
type Boolean
readonly
Returns whether the control should be removed.
editable
declaring type UIControl
type Boolean
readonly
Returns whether the value can be changed by user action.
UIControl (Output, etc.) that does not allow input returns false.
In the case of an inputtable UIControl, returns true if the binding context in which the value is bound is valid.
Otherwise, it returns false even if it is an inputtable UIControl.

Accordion/Button/Group/Dialog/EmbeddedApp/EmbeddedPage/Grid/HTMLObject/Image/MDIFolder/Menu/
NavigationBar/Notifier/Output/Progress/TabFolder/Shell/FileUpload
In the case of the above control, editable is always false.
enabled
declaring type EnableUIControl
type Boolean
get
Returns whether the control is enabled.
set
Sets whether to activate the control.
fieldLabel
declaring type UIControl
type String
get
Returns the logical field name of the control.
set
Sets the logical field name of the control.
focusable
declaring type UIControl
type Boolean
readonly
Returns whether the control is focusable.
focused
declaring type UIControl
type Boolean
readonly
Returns whether the control has focus.
headerArrowPosition
type TabHeaderArrowPosition
get
TabHeader arrow position setting: both, left, right
set
TabHeader arrow position setting: both, left, right
headerArrowVisible
type TabHeaderArrowVisibility
get
Gets a way to determine whether the scroll button in the tab item area is visible.
set
Specifies how to determine whether scroll buttons in the tab item area are displayed.
headerCheckable
type Boolean
get
Check whether TabItem Header can be checked
set
Check whether TabItem Header can be checked
headerControl
deprecatedPlease use addHeaderControl.
type UIControl
get
Get the header control.
set
Specifies the control to be displayed on the right side of the header of the tabbed folder.
headerControlWidth
deprecatedPlease use addHeaderControl.
type Number
headerPosition
type TabHeaderPosition
get
Gets the setting for the location where the tab header appears.
set
Sets where tab headers are displayed.
hideHeader
type Boolean
get
Returns whether to show or hide headers.
set
Sets whether to show or hide headers.
id
declaring type Control
type String
readonly
Returns the ID of the control.
itemAlign
type TabItemAlign
get
Gets a way to sort items.
set
Specifies how to sort items. Valid values ​​are defined in cpr.controls.TabItemAlign.
  • leading: Align to the left.
  • center: Align to the center.
  • trailing: Align to the right.
itemDisplayExp
type #expression
get
Gets an expression to apply transformations of the tab item's content and style.
set
Specifies an expression to apply transformations of the tab item's content and style.
itemDraggingMode
type ItemDraggingMode
get
Gets the drag handling mode of the tab item.
set
Specifies the drag handling mode for tab items.
itemSizing
type TabItemSizing
get
You get a way to determine the width of an item.
set
Specifies how to specify the width of the item. Valid values ​​are defined in cpr.controls.TabSizing.
  • auto: Width is automatically determined based on the tab item text.
  • fill: Distributes the width of each tab item equally across the entire tab area.
  • fixed: Have a fixed value size. The value can be specified as preferredItemWidth.
itemSpacing
type Number
get
Gets the gap between items.
set
Specifies the spacing between items. If this value is negative, items will appear on top of each other.
name
declaring type UIControl
type String
get
Returns the name of the control.
set
Sets the name of the control.
preferredItemWidth
type Number
get
If you use a fixed value for the width of the item, you get the value used for that width.
set
If you use a fixed value for the width of the item, specify the value used for that width.
readOnly
declaring type EnableUIControl
type Boolean
get
Returns whether a non-modifiable read-only mode is in effect.
set
Sets whether to enable read-only mode, which can not be modified.
showCloseOnlyActive
type Boolean
get
Returns whether the close button is visible for the active tab only.
Related properties: [tabItem.closable] When the closable property value is true, the close button is displayed.
set
Set whether to display the close button only for the active tab.
Related properties: [tabItem.closable] When the closable property value is true, the close button is displayed.
style
type TabFolder$Styler
readonly
Returns the style settings of the control.
In case of style changes, only the corresponding control is updated.
Propagation from style changes does not occur.
tabIndex
type Number
get
Returns the control focus order using the Tab Key.
This is a property to control the tabindex of HTML.
set
Set the control focus order using the Tab Key.
This is a property to control the tabindex of HTML.
tabsWithAutoSelection
type Boolean
get
Obtains whether to activate auto-selection when moving a tab item.
set
Set whether to enable automatic selection when moving tab items.
tooltip
declaring type VisibleUIControl
type String
get
Returns a description of the control
It works when mouse over.
set
Set a description for the control.
It works when mouse over.
type
declaring type Control
type ControlType
readonly
Returns the signature string of the Control's unique Type that can distinguish the Control. Please refer to ControlType for available constant values. For UDC controls, each unique type name is returned. Example: udc.MyUDC
useItemTextEllipsis
type Boolean
get
Obtains whether to use ellipsis in text when the item has insufficient display space.
set
Specifies whether to use ellipsis in text when the item has insufficient display space.
uuid
declaring type Control
type String
readonly
Returns the unique ID of the control.
visible
declaring type VisibleUIControl
type Boolean
get
Returns the style property for controlling css visibility.
set
Sets the style property to control css visibility.

Methods

addEventListener(type, listener)
declaring typeUIControl
Add listeners by EventType to the control.
Add a listener to the control to handle when a specific event occurs. 
var button = new cpr.controls.Button("btn01");
button.addEventListener("click", function(e) {
// event code...
});
Parameters
name type description
type String
listener (e: cpr.events.CEvent)=>Void
addEventListenerOnce(type, listener)
declaring typeUIControl
Add a listener to the control that will run only once per EventType.
Add a listener to the control to handle when a specific event occurs. The added listener is automatically deleted after running once. Since the object of the added listener is changed, when the listener is deleted It is an object returned after calling addEventListenerOnce and can be deleted. 
var button = new cpr.controls.Button("btn01");
button.addEventListenerOnce("click", function(e) {
// event code...
});
Parameters
name type description
type String
listener (e: cpr.events.CEvent)=>Void
return (e: cpr.events.CEvent)=>Void The modified Listener object.
addHeaderControl(control, constraint)
Add a header control.
Parameters
name type description
control UIControl Header control to add.
constraintoptional TabHeaderControlConstraint Header control width and position information.
addTabItem(tabItem)
Add a tab item.
Parameters
name type description
tabItem TabItem Tab items to add
bind(name)
declaring typeUIControl
Bind that property.
Parameters
name type description
name String
return IBindFactory Factory showing bind type.
blur()
declaring typeUIControl
Removes focus from the control.
close(item)
Close the tab item. If the closed item contains the embedded app, the "Before-UNLOD" event and the "Close" event are spread. If one of the handlers cancel the default behavior, the tap item closing operation is canceled. If the selected tab item is closed, change the nearest item from the index of the closed tab item to the selected tab item.
Parameters
name type description
item TabItem TabItem not closed
closeAll()
Close all tab items. If the tab item is displaying an embedded app, the "before-unload" and "close" events are propagated. If one of the event handlers cancels the default action, the tab item will not be closed.
closeOthers()
Closes all TabItems except the selected TabItem.
closeOthers(itemsToAlive)
Close the remaining Tabitem except for the arrangement of the array that has been handed over as an argument. If there is no Tabitem in the array, the rest of the Tabitem will be closed except for the current selected Tabitem. If the selected item is closed, change it to the tap item that has been passed over to the argument.
Parameters
name type description
itemsToAlive TabItem[] An array of TabItems that will not be closed.
closeOthers(itemToAlive)
Close Tabitem except Tabitem, which has been handed over as an argument. If the selected item is closed, change it to the tap item that has been passed over to the argument.
Parameters
name type description
itemToAlive TabItem TabItem that will not be closed.
confirmEvent(e)
declaring typeUIControl
Determines whether to run the Control's Default Event Handler depending on the state of the Control.
Parameters
name type description
e CEvent event
return Boolean Whether the control's event handler is running.
dispatchEvent(e)
declaring typeUIControl
Forwards specific events.
Parameters
name type description
e CEvent
return Boolean Whether to continue processing the default action after propagating the event.
dispose()
Removes the objects that the control contains.
findParent(predicate, includeSelf)
declaring typeUIControl
Find the parent control.
If includeSelf is true, the parent including the self is found.
Parameters
name type description
predicate (c: cpr.controls.UIControl)=>Boolean
includeSelfoptional Boolean defaultfalse Whether you include yourself.
return UIControl Parental control.
focus(forward)
Assigns focus to the control.
Parameters
name type description
forwardoptional Boolean defaulttrue
focusNext()
declaring typeUIControl
Moves focus to the next control. If there are multiple structural elements that have focus inside a control, focus may transition to the next element.
focusPrevious()
declaring typeUIControl
Moves focus to the previous control. If there are multiple structural elements that have focus inside a control, focus may transfer to the previous element.
getActualRect()
declaring typeUIControl
Gets the bounds value of the control relative to the browser's view port. If the control is not drawn on the screen, an object with all values ​​of 0 is returned.
return Rectangle About the position and size of controls in the HTML DOM
getActualRect(includeWrap)
declaring typeUIControl
Gets the bounds value of the control relative to the browser's view port. If the control is not drawn on the screen, an object with all values ​​of 0 is returned.
Parameters
name type description
includeWrap Boolean If this value is true, the layout of the parent group gets the area of ​​the node surrounding this control. If false, only get the area of ​​the control node.
return Rectangle About the position and size of controls in the HTML DOM
getActualRect(options)
declaring typeUIControl
Gets the bounds value of the control relative to the browser's view port. If the control is not drawn on the screen, an object with all values ​​0 is returned.
Parameters
name type description
options { includeWrap?: Boolean, scaled?: Boolean }
return Rectangle
getAllItemsByName(name)
Get items by item name.
Parameters
name type description
name String The names of the items to find.
return TabItem[]
getAllRecursiveChildren(includeSelf)
declaring typeContainer
Recursively gets all child controls contained in this container and all controls contained in subcontainers. Internal elements such as embedded apps and UDCs are not included in the returned results.
Parameters
name type description
includeSelfoptional Boolean defaultfalse Whether to include itself in the return value.
return UIControl[]
getAllRecusiveChildren(includeSelf)
declaring typeContainer
deprecatedThe API was provided incorrectly due to a typo. Please use getAllRecursiveChildren instead.
Recursively gets all child controls contained in this container and all controls contained in subcontainers. Internal elements such as embedded apps and UDCs are not included in the returned results.
Parameters
name type description
includeSelfoptional Boolean defaultfalse Whether to include itself in the return value.
return UIControl[]
getAppInstance()
declaring typeUIControl
Returns the App to which the control belongs.
return AppInstance App that belongs
getBindContext()
declaring typeUIControl
Returns the bind context.
return BindContext bind context
getBindInfo(name)
declaring typeUIControl
Returns the bind property information for the control.
Parameters
name type description
name String
return BindInfo BindInfo Properties
getCheckedTabItems()
Get checked tap items.
return TabItem[] Array of checked tab items.
getChild(childId)
declaring typeContainer
Get the immediate child controls within the container by ID.
Parameters
name type description
childId String The ID of the child control to get.
return UIControl Any of the immediate child controls that match the given ID. Returns null if it doesn't exist.
getChildren()
declaring typeContainer
Get all child controls.
return UIControl[] An array of child controls.
getChildrenCount()
declaring typeContainer
Returns the number of child controls.
return Number Number of child controls
getFirstChild()
declaring typeContainer
Get the first child control.
return UIControl First child control.
getHeaderControls()
Get all the header controls.
return UIControl[]
getHtmlAttrNames()
declaring typeUIControl
Returns all custom DOM DATA attribute names.
return String[] An array of all custom DOM DATA attribute names.
getItemBounds(item)
Gets the bounds that the given tab item is displaying on the browser viewport.
Parameters
name type description
item TabItem Tab item to get the viewport bounds.
return Rectangle
getItemByName(name)
Get the item by its name. If there are multiple tab items with the same name, only the first result is returned.
Parameters
name type description
name String The name of the item to find.
return TabItem
getItemForContent(content)
Finds and returns a TabItem with the given control as its content. If it does not exist, null is returned.
Parameters
name type description
content UIControl The content control of the TabItem you want to find.
return TabItem
getItemsDelegate()
return TabItemsDelegate Additional action technology objects related to tab items.
getLastChild()
declaring typeContainer
The last child gets control.
return UIControl Last child control.
getNextControl()
declaring typeUIControl
Returns the control to be moved by Tab Key or by the autoskip property.
return UIControl control.
getOffsetRect(includeWrap)
declaring typeUIControl
The area being displayed is obtained based on the parent container to which it belongs.
Parameters
name type description
includeWrapoptional Boolean defaultfalse If this value is true, the layout of the parent group gets the area of ​​the node surrounding this control. If false, only get the area of ​​the control node.
return Rectangle
getParent()
declaring typeUIControl
Gets the parent control.
return Container Parental control.
getPrevControl()
declaring typeUIControl
Shift + Tab Returns the focus to be moved through the key.
return UIControl control.
getSelectedTabItem()
Get the selected tap items.
return TabItem Array of selected tab items.
getTabItemByID(itemId)
Use the tab item id (unique number) to get the tab item.
Parameters
name type description
itemId Number The id (unique number) of the tab item to find.)
return TabItem
getTabItems()
Get all tap items.
return TabItem[] An array of all tab items.
getUserAttrNames()
declaring typeControl
Returns all custom attribute names.
return String[] An array of all custom attribute names.
getVisualParentControl()
declaring typeUIControl
Gets the closest parent UI control. Unlike getParent(), it finds nearby parent controls, including external apps.
return UIControl
htmlAttr(key, value)
declaring typeUIControl
Specifies custom DOM properties.
Parameters
name type description
key String The attribute name to assign
value String The attribute value to specify.
htmlAttr(key)
declaring typeUIControl
Returns a custom DOM property.
Parameters
name type description
key String The attribute name to get.
return String Custom properties.
htmlAttr(values)
declaring typeUIControl
Specify multiple custom DOM properties at once.
Parameters
name type description
values {[key:string]: String} A JSON object containing custom attribute keys/values.
htmlAttr()
declaring typeUIControl
Get all custom DOM properties in the form of a map.
return {[key:string]: String}
insertTabItem(index, tabItem, after)
Insert a tab item. The default is inserted before.
Parameters
name type description
index Number Where to insert
tabItem TabItem Tab item to insert
afteroptional Boolean defaultfalse Whether to insert before or after the position.
isAvailableBinding(name)
declaring typeUIControl
Returns whether the queried property is bindable and the binding has been configured to obtain a valid value. Even if no binding is configured and a simple value is specified, it is treated as configured so that a valid value is obtained. For example, binding to a row index that does not exist in the DataSet is an invalid binding.
Parameters
name type description
name String
return Boolean
isBindable(name)
declaring typeUIControl
Make sure it is a bindable property.
Parameters
name type description
name String
return Boolean Confirmation.
isFloated()
declaring typeUIControl
Returns whether the control is floating through an app instance or a specific container.
return Boolean
isShowing()
declaring typeUIControl
Returns the status that the screen is showing. Returns false if the visible state of all parents including itself is false.
return Boolean
redraw()
declaring typeContainer
Redraw the control.
removeAllChildren(shouldDispose)
Removes all child controls.
Parameters
name type description
shouldDisposeoptional Boolean defaultfalse
removeAllEventListeners()
declaring typeControl
Removes all event listeners for the control.
removeAllHtmlAttr()
declaring typeUIControl
Delete all custom DOM DATA attributes.
removeAllUserAttr()
declaring typeControl
Delete all custom attributes.
removeChild(childControl, shouldDispose)
Remove the control.
Parameters
name type description
childControl UIControl
shouldDisposeoptional Boolean defaultfalse
removeEventListener(type, listener)
declaring typeControl
Remove Listener for each EventType in the control. 
control.removeEventListener ('click', listener);
Parameters
name type description
type String Event type.
listener (e: cpr.events.CEvent)=>Void Event listeners.
removeEventListeners(type)
declaring typeControl
Remove all EventType listeners from the control. 
control.removeEventListeners ('click');
Parameters
name type description
type String Event type.
removeHeaderControl(control)
Remove the header control.
Parameters
name type description
control UIControl Header control to remove
removeHtmlAttr(key)
declaring typeUIControl
Removes the user-defined DOM DATA attribute for a specific attribute name.
Parameters
name type description
key String The custom DOM DATA attribute name to remove.
removeTabItem(tabItem)
Removes the tab item.
Parameters
name type description
tabItem TabItem Tab item to remove
removeUserAttr(key)
declaring typeControl
Removes user-defined attributes for a specific attribute name.
Parameters
name type description
key String The custom attribute name to remove.
reorderTabItem(item, newIndex, isFutureIndex)
Change the order of specific tab items.
Parameters
name type description
item TabItem Tab item to change order.
newIndex Number New order.
isFutureIndexoptional Boolean defaultfalse Whether the new index is the tab item order index after the order adjustment. If this value is false (the default), new indices will be interpreted relative to the current state. If this value is true>, the new index is interpreted as the index after method execution. (default)
setBindContext(context)
declaring typeUIControl
Sets the bind context. 
container.setBindContext({dataControl:grid.dataSet,rowIndex:rowIndex})
Parameters
name type description
context BindContext bind context
setItemsDelegate(delegate)
Specifies additional behavior related to tab items.
Parameters
name type description
delegate TabItemsDelegate Additional action description objects related to tab items.
setNextControl(nextControl)
declaring typeUIControl
Sets the control to be moved by Tab Key or by the autoskip property.
Parameters
name type description
nextControl UIControl control.
setPrevControl(prevControl)
declaring typeUIControl
Shift + Tab Set the focus to be moved through the key.
Parameters
name type description
prevControl UIControl control.
setSelectedTabItem(tabItem, emitEvent)
Specifies the selected tab item.
Parameters
name type description
tabItem TabItem tab item to select
emitEventoptional Boolean defaulttrue Whether to propagate events (before-selection-change, selection-change).
unbind(name)
declaring typeUIControl
Unbind that property.
Parameters
name type description
name String
userAttr(key, value)
declaring typeControl
Specifies custom properties.
Parameters
name type description
key String The attribute name to assign
value String The attribute value to specify.
userAttr(key)
declaring typeControl
Returns a user-defined property.
Parameters
name type description
key String The attribute name to get.
return String Custom properties.
userAttr(values)
declaring typeControl
Specify multiple custom properties at once.
Parameters
name type description
values {[key:string]: String} A JSON object containing custom attribute keys/values.
userAttr()
declaring typeControl
Get all custom properties in the form of a map.
return {[key:string]: String}
userData(key, value)
declaring typeControl
Specifies custom data. Unlike user-defined attributes, you can use arbitrary types in addition to strings. When the control is dispose, all custom data is removed.
Parameters
name type description
key String The key of the data to be specified.
value Object Data to specify.
userData(key)
declaring typeControl
get custom data
Parameters
name type description
key String The key of the data to get.
return Object
userData(override)
declaring typeControl
Specifies multiple user-defined data.
Parameters
name type description
override {[key:string]: Object} A JSON object containing user-defined data.
userData()
declaring typeControl
Get all your custom data.
return {[key:string]: Object}
userattr()
declaring typeControl
deprecatedPlease use userAttr.
Returns a user-defined property.
return Object Custom properties.