cpr.controls.EmbeddedApp

A component that can embed an app in an app.
Hierarchy

Index

Events
Event Description
animationend Event that occurs after the animation ends.
animationstart Event that occurs at the start of the animation.
app-change Event propagated when the app of the embedded app is replaced or designated.
app-ready An event dispatched when an instance of the embedded app and its associated resources are ready.
before-context-value-change Use a bind context in a control that has a bind context An event that occurs before the value changes.
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.
host-change This event occurs when the app is included in or leaves the parent app.
init An event in which an instance of an embedded app is created, dispatched after the data and control configuration is complete.
keydown Event raised when the user presses a key.
keyup Event that occurs when the user releases the key.
load An event dispatched when an instance of the embedded app and its associated resources are ready.
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.
app App Returns the app.
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.
initValue Object Returns the value received by the embedded app at startup.
module Object Returns module of Embedded App.
name String Returns the name of the control.
readOnly Boolean Returns whether a non-modifiable read-only mode is in effect.
returnValue Object Returns the value that the embedded app returns.
style UIControlStyler Returns the style settings of the control.
tabIndex Number
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
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.
bind IBindFactory Bind that property.
blur Removes focus from the control.
callAppMethod Object Invoke the method of the App.
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 contained in the control.
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.
forceRun Promise<cpr.controls.EmbeddedApp> Even if there is no need to run the embedded app because it is not being displayed on the screen, the app is forcibly started.
getActualRect Rectangle Gets the bounds value of the control relative to the browser's view port.
getAllAppProperties {[key:string]: Object} Get all app properties.
getAppInstance AppInstance Returns the App to which the control belongs.
getAppProperty Object Returns the value of the corresponding property in the App.
getAppPropertyAsBoolean Boolean Get the app property value in boolean format.
getAppPropertyAsNumber Number Get the app property value in number format.
getAppPropertyAsString String Get the app property value in string format.
getBindContext BindContext Returns the bind context.
getBindInfo BindInfo Returns the bind property information for the control.
getEmbeddedAppInstance AppInstance Returns the Embedded App Instance.
getHtmlAttrNames String[] Returns all custom DOM DATA attribute names.
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.
getVisualParentControl UIControl Gets the closest parent UI control.
hasAppMethod Boolean Returns whether the app has a method.
htmlAttr Specifies custom DOM properties.
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.
ready Promise<cpr.controls.EmbeddedApp> Register the job to be processed after the embedded app is ready.
redraw Redraw the control.
removeAllEventListeners Removes all event listeners for the control.
removeAllHtmlAttr Delete all custom DOM DATA attributes.
removeAllUserAttr Delete all custom attributes.
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.
setAppProperties Specify multiple app properties at once.
setAppProperty Sets the properties of the App.
setBindContext Sets the bind context.
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.
unsetAllAppProperties Returns all app properties with default values ​​to their initial state.
unsetAppProperty Returns the values ​​of certain app properties to their default values.
userAttr Specifies custom properties.
userData Specifies custom data.
userattr Object Returns a user-defined property.

Constructor

EmbeddedApp(id, app)
Create an embedded app.
Parameters
name type description
idoptional String The id of the embedded app.
appoptional App An app that will go inside an embedded app.

Events

animationend
CAnimationEvent Event that occurs after the animation ends.
animationstart
CAnimationEvent Event that occurs at the start of the animation.
app-change
CSelectionEvent Event propagated when the app of the embedded app is replaced or designated.
app-ready
CEvent An event dispatched when an instance of the embedded app and its associated resources are ready.
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.
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.
host-change
CEvent This event occurs when the app is included in or leaves the parent app.
init
CEvent An event in which an instance of an embedded app is created, dispatched after the data and control configuration is complete.
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.
load
CEvent An event dispatched when an instance of the embedded app and its associated resources are ready.
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.
app
type App
get
Returns the app.
set
Set up your app. If the app is changed, all tasks scheduled with ready () will be canceled.
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.
id
declaring type Control
type String
readonly
Returns the ID of the control.
initValue
type Object
get
Returns the value received by the embedded app at startup.
set
Sets the value to be passed when the embedded app starts.
module
type Object
readonly
Returns module of Embedded App.
name
declaring type UIControl
type String
get
Returns the name of the control.
set
Sets the name of the control.
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.
returnValue
type Object
get
Returns the value that the embedded app returns.
set
Sets the value at which the embedded app is returned.
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.
tabIndex
type Number
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

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.
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.
callAppMethod(name, args)
Invoke the method of the App.
Parameters
name type description
name String method name
args Array The parameters in the method.
return Object string | object | number | undefined Returns the result of the invoked method, or undefined if there is no return.
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 contained in the control.
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.
forceRun(callback)
Even if there is no need to run the embedded app because it is not being displayed on the screen, the app is forcibly started. If the app has not yet been assigned, the app will be launched immediately when the app is assigned later. This action cannot be undone.
Parameters
name type description
callbackoptional (embeddedApp: cpr.controls.EmbeddedApp)=>Void Callback after app launch.
return Promise<cpr.controls.EmbeddedApp>
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
getAllAppProperties()
Get all app properties.
return {[key:string]: Object}
getAppInstance()
declaring typeUIControl
Returns the App to which the control belongs.
return AppInstance App that belongs
getAppProperty(propertyName)
Returns the value of the corresponding property in the App.
Parameters
name type description
propertyName String property name.
return Object The value of the property.
getAppPropertyAsBoolean(propertyName)
Get the app property value in boolean format.
Parameters
name type description
propertyName String Property name.
return Boolean
getAppPropertyAsNumber(propertyName)
Get the app property value in number format.
Parameters
name type description
propertyName String Property name.
return Number
getAppPropertyAsString(propertyName)
Get the app property value in string format.
Parameters
name type description
propertyName String Property name.
return String
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
getEmbeddedAppInstance()
Returns the Embedded App Instance.
return AppInstance Embedded App Instance.
getHtmlAttrNames()
declaring typeUIControl
Returns all custom DOM DATA attribute names.
return String[] An array of all custom DOM DATA attribute names.
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.
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
hasAppMethod(name)
Returns whether the app has a method.
Parameters
name type description
name String method name.
return Boolean Include method.
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}
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
ready(handler)
Register the job to be processed after the embedded app is ready. If the app is already running, it will be done immediately. If the app is not running, it will be called shortly before the app is ready and running. If the app changes before this job is run, the jobs are canceled.
Parameters
name type description
handleroptional (app: cpr.controls.EmbeddedApp)=>Void A function that contains an action to be taken after the app is ready.
return Promise<cpr.controls.EmbeddedApp>
redraw()
declaring typeUIControl
Redraw the control.
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.
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.
setAppProperties(properties, fireEvent)
Specify multiple app properties at once.
Parameters
name type description
properties {[key:string]: Object} The attribute JSON object to specify.
fireEventoptional Boolean defaulttrue Whether to propagate property-change events.
setAppProperty(propertyName, value, fireEvent)
Sets the properties of the App.
Parameters
name type description
propertyName String property name.
value Object The property value.
fireEventoptional Boolean defaulttrue Whether to propagate property-change events.
setBindContext(context)
declaring typeUIControl
Sets the bind context. 
container.setBindContext({dataControl:grid.dataSet,rowIndex:rowIndex})
Parameters
name type description
context BindContext bind context
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
unsetAllAppProperties(fireEvent)
Returns all app properties with default values ​​to their initial state. The values ​​of all app properties declared with declareAppProperty () and declareBindableAppProperty () are reset to their initial values.
Parameters
name type description
fireEventoptional Boolean defaulttrue Whether to propagate property-change events.
unsetAppProperty(propertyName, fireEvent)
Returns the values ​​of certain app properties to their default values.
Parameters
name type description
propertyName String App property name to return to default.
fireEventoptional Boolean defaulttrue Whether to propagate property-change events.
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.