cpr.controls.Container

Container/Group A control that allows you to create a set of controls.

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.
click	An event that occurs when the user clicks the control.
context-value-change	Use a bind context in a control that has a bind context An event that occurs after the value changes.
contextmenu	When the right mouse button is clicked or the context menu key is pressed, Event 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.
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.
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.
id	String	Returns the ID of the control.
isAppContainer	Boolean	Returns whether it is an AppContainer.
name	String	Returns the name of the control.
overscrollBehavior	OverscrollBehaviorType	Returns a value that defines the parent's scrolling behavior when the end of the scrollable area is reached by the mouse wheel or touch event.
readOnly	Boolean	Returns whether a non-modifiable read-only mode is in effect.
style	UIControlStyler	Returns the style settings of the control.
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.
uuid	String	Returns the unique ID of the control.
visible	Boolean	Returns the style property for controlling css visibility.

Methods

Name	Return Type	Description
addChild		Add controls to this container.
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.
adjustScroll		Adjust the position of the scroll.
bind	IBindFactory	Bind that property.
blur		Removes focus from the control.
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.
floatControl		It is included at the end of the container and is not affected by the layout.
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.
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.
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.
getConstraint	Constraint	Gets the layout attributes of that control.
getContentPaneRect	Rectangle	I get the whole child area.
getFirstChild	UIControl	Get the first child control.
getHtmlAttrNames	String[]	Returns all custom DOM DATA attribute names.
getLastChild	UIControl	The last child gets control.
getLayout	Layout<Object>	Returns the layout.
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.
getUserAttrNames	String[]	Returns all custom attribute names.
getViewPortRect	Rectangle	Gets the scrolling viewport area being displayed inside the container.
getVisualParentControl	UIControl	Gets the closest parent UI control.
htmlAttr		Specifies custom DOM properties.
insertChild		Add child controls to a specific index.
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.
makeRelativePoint	Point	Converts browser viewport base coordinates to relative coordinates for this container.
makeRelativeRect	Rectangle	Converts to the relative coordinates for this container based on the browser viewport bounce object.
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.
removeHtmlAttr		Removes the user-defined DOM DATA attribute for a specific attribute name.
removeUserAttr		Removes user-defined attributes for a specific attribute name.
reorderChild		Change the order of the children of the container.
replaceChild	{ key: cpr.controls.UIControl, value: cpr.controls.layouts.Constraint }	Replaces an existing child control with a new control.
replaceConstraint	Boolean	Replaces the layout attributes of a control.
reveal		If the container contains scrolling, scrolls to display a specific child.
scrollTo		If the container contains scrolling, scroll to that position.
setBindContext		Sets the bind context.
setLayout		Sets the layout.
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.
unbind		Unbind that property.
updateConstraint	Boolean	Updates the layout attributes of a control.
userAttr		Specifies custom properties.
userData		Specifies custom data.
userattr	Object	Returns a user-defined property.

Constructor

Container(id)

Create a group.

Parameters

name	type		description
idoptional	String		group id

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.

click

CMouseEvent An event that occurs when the user clicks the control.

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 When the right mouse button is clicked or the context menu key is pressed, Event called.

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.

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.

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

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

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.

declaring type	Control
type	String
readonly	Returns the ID of the control.

isAppContainer

type	Boolean
readonly	Returns whether it is an AppContainer.

name

declaring type	UIControl
type	String
get	Returns the name of the control.
set	Sets the name of the control.

overscrollBehavior

type	OverscrollBehaviorType
get	Returns a value that defines the parent's scrolling behavior when the end of the scrollable area is reached by the mouse wheel or touch event. The default value is AUTO, which delegates scrolling behavior to the parent.
set	Sets a value that defines the parent's scrolling behavior when the end of the scrollable area is reached by the mouse wheel or touch event. OverscrollBehaviorType.AUTO: Delegates scrolling behavior to parent. OverscrollBehaviorType.NONE: Blocks propagation to the parent.

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.

style

declaring type	UIControl
type	UIControlStyler
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.

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

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

addChild(child, constraint)

Add controls to this container.
If the container's layout is responsive, you must specify a media query.

Parameters

name	type		description
child	UIControl		The control to add.
constraintoptional	Constraint	default`{}`	Layout characteristics. The layout attribute must be in the format specified by the layout specified in the container.

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.

adjustScroll(leftDelta, topDelta, duration, timingFunction)

Adjust the position of the scroll.

Parameters

name	type		description
leftDelta	Number		Horizontal scroll shift value
topDelta	Number		Vertical scroll shift value
durationoptional	Number	default`0`	Animation operation time. (Unit: second) default = 0
timingFunctionoptional	String	default`animation.TimingFunction.EASE_IN_OUT`	Timing function. default = animation.TimingFunction.EASE_IN_OUT

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.

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	default`false`	Whether you include yourself.

return	UIControl	Parental control.

floatControl(child, styles)

It is included at the end of the container and is not affected by the layout. Use Container.removeChild to delete the control.

Parameters

name	type		description
child	UIControl		Control to plot
stylesoptional	{[key:string]: String}	default`{}`	A style or cpr.geometry.Rectangle object that describes the position of the control to be displayed.

focus(forward)

declaring typeUIControl

Assigns focus to the control.

Parameters

name	type		description
forwardoptional	Boolean	default`true`

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

getAllRecursiveChildren(includeSelf)

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	default`false`	Whether to include itself in the return value.

return	UIControl[]

getAllRecusiveChildren(includeSelf)

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	default`false`	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

getChild(childId)

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()

Get all child controls.

return	UIControl[]	An array of child controls.

getChildrenCount()

Returns the number of child controls.

return	Number	Number of child controls

getConstraint(child)

Gets the layout attributes of that control.

Parameters

name	type		description
child	UIControl		Child controls to get layout attributes.

return	Constraint	The layout attributes of its child controls.

getContentPaneRect()

I get the whole child area.

return	Rectangle

getFirstChild()

Get the first child control.

return	UIControl	First child control.

getHtmlAttrNames()

declaring typeUIControl

Returns all custom DOM DATA attribute names.

return	String[]	An array of all custom DOM DATA attribute names.

getLastChild()

The last child gets control.

return	UIControl	Last child control.

getLayout()

Returns the layout.

return	Layout<Object>	layout

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	default`false`	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.

getUserAttrNames()

declaring typeControl

Returns all custom attribute names.

return	String[]	An array of all custom attribute names.

getViewPortRect(options)

Gets the scrolling viewport area being displayed inside the container.

Parameters

name	type		description
optionsoptional	{ scaled?: Boolean }

return	Rectangle

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}

insertChild(index, child, constraint)

Add child controls to a specific index.

Parameters

name	type		description
index	Number		Index to add child
child	UIControl		Child control.
constraintoptional	Constraint	default`{}`	The layout attributes of the child control.

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

makeRelativePoint(actualLocation)

Converts browser viewport base coordinates to relative coordinates for this container.

Parameters

name	type		description
actualLocation	Point		Coordinate to convert

return	Point

makeRelativeRect(actualRect)

Converts to the relative coordinates for this container based on the browser viewport bounce object.

Parameters

name	type		description
actualRect	Rectangle		Rectangle object to get relative coordinates.

return	Rectangle

redraw()

Redraw the control.

removeAllChildren(shouldDispose)

Removes all child controls.

Parameters

name	type		description
shouldDisposeoptional	Boolean	default`false`	Whether control objects are removed.

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		The control you want to remove.
shouldDisposeoptional	Boolean	default`false`	Whether control objects are removed.

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.
            
          
        
      
    

    
      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.
            
          
        
      
    

    
      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.
            
          
        
      
    

    
      reorderChild(child, newIndex, isFutureIndex)
      Change the order of the children of the container. You can change the order to determine the priority that appears when overlapping between controls.
      
        Parameters
        
          
            
              name
              type
              description
            
          
          
            
              child
              
              UIControl
              Child controls of container
            
            
              newIndex
              
              Number
              The new index.
            
            
              isFutureIndexoptional
              
              Boolean
              defaultfalse
              
              Whether the new index is the index of the child after control relocation. 
If this value is false, the new index will be interpreted relative to the current state.
If this value is true, the new index is interpreted as the index after method execution.
            
          
        
      
    

    
      replaceChild(oldChild, newChild, constraints)
      Replaces an existing child control with a new control.
If the given existing control does not exist, it does nothing.
      
        Parameters
        
          
            
              name
              type
              description
            
          
          
            
              oldChild
              
              UIControl
              Existing controls to be removed.
            
            
              newChild
              
              UIControl
              The control to replace.
            
            
              constraintsoptional
              
              Constraint
              default{}
              
              Layout characteristics.
            
          
        
      
      
        
          
            return
            
            {
  key: cpr.controls.UIControl,
  value: cpr.controls.layouts.Constraint
}
            New control information. Returns null if no replacement operation has occurred because the existing control does not exist.
          
        
      
    

    
      replaceConstraint(child, newConstraint)
      Replaces the layout attributes of a control.
      
        Parameters
        
          
            
              name
              type
              description
            
          
          
            
              child
              
              UIControl
              The control whose layout attributes you want to change.
            
            
              newConstraint
              
              Constraint
              New layout properties. 
The layout attribute must be in a format supported by the layout of the Container to which the control belongs.
            
          
        
      
      
        
          
            return
            
            Boolean
            Whether a given layout property and changes exist.
          
        
      
    

    
      reveal(child, duration, timingFunction)
      If the container contains scrolling, scrolls to display a specific child.
      
        Parameters
        
          
            
              name
              type
              description
            
          
          
            
              child
              
              UIControl
              Child controls to display.
            
            
              durationoptional
              
              Number
              default0.3
              
              The length of the scroll animation. (Unit: second)
            
            
              timingFunctionoptional
              
              String
              defaultanimation.TimingFunction.EASE_IN_OUT
              
              Timing function to be applied when using animation.
            
          
        
      
    

    
      scrollTo(left, top, duration, timingFunction)
      If the container contains scrolling, scroll to that position.
      
        Parameters
        
          
            
              name
              type
              description
            
          
          
            
              left
              
              Number
              X-coordinate to scroll.
            
            
              top
              
              Number
              Y-coordinate to scroll.
            
            
              durationoptional
              
              Number
              default0
              
              The length of the scroll animation. The unit is seconds.
            
            
              timingFunctionoptional
              
              String
              defaultanimation.TimingFunction.EASE_IN_OUT
              
              Timing function to be applied when using animation.
            
          
        
      
    

    
      setBindContext(context)
      declaring typeUIControl
      
      Sets the bind context.
container.setBindContext({dataControl:grid.dataSet,rowIndex:rowIndex})
      
        Parameters
        
          
            
              name
              type
              description
            
          
          
            
              context
              
              BindContext
              bind context
            
          
        
      
    

    
      setLayout(layout)
      Sets the layout.
      
        Parameters
        
          
            
              name
              type
              description
            
          
          
            
              layout
              
              Layout<Object>
              layout
            
          
        
      
    

    
      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.
            
          
        
      
    

    
      unbind(name)
      declaring typeUIControl
      
      Unbind that property.
      
        Parameters
        
          
            
              name
              type
              description
            
          
          
            
              name
              
              String
              
            
          
        
      
    

    
      updateConstraint(child, overridingConstraint)
      Updates the layout attributes of a control.
Predefined layout characteristics and newly given characteristics are merged.
      
        Parameters
        
          
            
              name
              type
              description
            
          
          
            
              child
              
              UIControl
              The control whose layout attributes are to be updated.
            
            
              overridingConstraint
              
              Constraint
              Layout attributes to add or change.
            
          
        
      
      
        
          
            return
            
            Boolean
            Whether there are changes from the given layout properties after the update.
          
        
      
    

    
      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.

name	type		description
type	String		Event type.
listener	(e: cpr.events.CEvent)=>Void		Event listeners.

name	type		description
child	UIControl		Child controls of container
newIndex	Number		The new index.
isFutureIndexoptional	Boolean	default`false`	Whether the new index is the index of the child after control relocation. If this value is `false`, the new index will be interpreted relative to the current state. If this value is `true`, the new index is interpreted as the index after method execution.

name	type		description
oldChild	UIControl		Existing controls to be removed.
newChild	UIControl		The control to replace.
constraintsoptional	Constraint	default`{}`	Layout characteristics.

name	type		description
child	UIControl		The control whose layout attributes you want to change.
newConstraint	Constraint		New layout properties. The layout attribute must be in a format supported by the layout of the Container to which the control belongs.

name	type		description
child	UIControl		Child controls to display.
durationoptional	Number	default`0.3`	The length of the scroll animation. (Unit: second)
timingFunctionoptional	String	default`animation.TimingFunction.EASE_IN_OUT`	Timing function to be applied when using animation.

name	type		description
left	Number		X-coordinate to scroll.
top	Number		Y-coordinate to scroll.
durationoptional	Number	default`0`	The length of the scroll animation. The unit is seconds.
timingFunctionoptional	String	default`animation.TimingFunction.EASE_IN_OUT`	Timing function to be applied when using animation.

name	type		description
child	UIControl		The control whose layout attributes are to be updated.
overridingConstraint	Constraint		Layout attributes to add or change.

name	type		description
key	String		The key of the data to be specified.
value	Object		Data to specify.