AR_Engine_SDK
Functions | Variables
XUIEditBox.lua File Reference
类 XUIEditBox 继承关系图:
Inheritance graph
类 XUIEditBoxDelegate 继承关系图:
Inheritance graph
类 XUIEditBoxDelegateLambda 继承关系图:
Inheritance graph

Functions

function XUIEditBox Create () end
 
function XUIEditBox Create (strNormalTexture, eTextureType) end
 
function XUIEditBox new () end
 
function XUIEditBox Draw (pWorld, unParentFlags) end
 
function XUIEditBox GetImage () end
 
function XUIEditBox LoadTexture (strTexture, eTextureType) end
 
function XUIEditBox GetTexture () end
 
function XUIEditBox SetPosition (vPos) end
 
function XUIEditBox SetVisible (bVisible) end
 
function XUIEditBox SetContentSize (vSize) end
 
function XUIEditBox SetAnchorPoint (vAnchorPoint) end
 
function XUIEditBox OnEnter () end
 
function XUIEditBox OnExit () end
 
function XUIEditBox Update (fDelta) end
 
function XUIEditBox SetDelegate (pDelegate) end
 
function XUIEditBox GetDelegate () end
 
function XUIEditBox SetText (strText) end
 
function XUIEditBox GetText () end
 
function XUIEditBox SetFont (strFont, nFontSize) end
 
function XUIEditBox SetFontName (strFont) end
 
function XUIEditBox GetFontName () end
 
function XUIEditBox SetFontSize (nFontSize) end
 
function XUIEditBox GetFontSize () end
 
function XUIEditBox SetFontColor (color) end
 
function XUIEditBox GetFontColor () end
 
function XUIEditBox SetPlaceholderText (strText) end
 
function XUIEditBox GetPlaceholderText () end
 
function XUIEditBox SetPlaceholderFont (strFont, nFontSize) end
 
function XUIEditBox SetPlaceholderFontName (strFont) end
 
function XUIEditBox GetPlaceholderFontName () end
 
function XUIEditBox SetPlaceholderFontSize (nFontSize) end
 
function XUIEditBox GetPlaceholderFontSize () end
 
function XUIEditBox SetPlaceholderFontColor (color) end
 
function XUIEditBox GetPlaceholderFontColor () end
 
function XUIEditBox SetInputMode (eInputMode) end
 
function XUIEditBox GetInputMode () end
 
function XUIEditBox SetMaxLength (nMaxLength) end
 
function XUIEditBox GetMaxLength () end
 
function XUIEditBox SetInputFlag (eInputFlag) end
 
function XUIEditBox GetInputFlag () end
 
function XUIEditBox SetReturnType (eReturnType) end
 
function XUIEditBox GetReturnType () end
 
function XUIEditBox SetTextHorizontalAlignment (eAlignment) end
 
function XUIEditBox GetTextHorizontalAlignment () end
 
function XUIEditBox TouchDownAction (pNode, controlEvent) end
 
function XUIEditBox OnFocusLost () end
 
function XUIEditBox SetFollowKeyBoardMoved (bFollow) end
 
function XUIEditBox IsFollowKeyBoardMoved () end
 
function XUIEditBox SetFollowKeyBoardMovedNode (pNode) end
 
function XUIEditBox GetPositionYBeforeKeyBoardShow () end
 
function XUIEditBox GetPositionYAfterKeyBoardShow () end
 
function XUIEditBox EndEditingWhenLostFocus (bSet) end
 
function XUIEditBox ForceEndEditing () end
 
function XUIEditBox OnKeyBoardShow (fKeyBoardHeight, fDelta) end
 
function XUIEditBox OnKeyBoardHide () end
 
function XUIEditBoxDelegateLambda EditBoxReturnKeyPressed (pEditBox, strText, eType) end
 

Variables

 XUIEditBox = {}
 
XUIEditBox XUI_DEFAULT = 0
 
XUIEditBox XUI_DONE = 0
 
XUIEditBox XUI_SEND = 0
 
XUIEditBox XUI_SEARCH = 0
 
XUIEditBox XUI_GO = 0
 
XUIEditBox XUI_NEXT = 0
 
XUIEditBox XUI_ANY = 0
 
XUIEditBox XUI_EMAIL_ADDRESS = 0
 
XUIEditBox XUI_NUMERIC = 0
 
XUIEditBox XUI_PHONE_NUMBER = 0
 
XUIEditBox XUI_URL = 0
 
XUIEditBox XUI_DECIMAL = 0
 
XUIEditBox XUI_SINGLE_LINE = 0
 
XUIEditBox XUI_PASSWORD = 0
 
XUIEditBox XUI_SENSITIVE = 0
 
XUIEditBox XUI_INITIAL_CAPS_WORD = 0
 
XUIEditBox XUI_INITIAL_CAPS_SENTENCE = 0
 
XUIEditBox XUI_INITIAL_CAPS_ALL_CHARACTERS = 0
 
XUIEditBox XUI_LOWERCASE_ALL_CHARACTERS = 0
 
XUIEditBox LEFT = 0
 
XUIEditBox CENTER = 0
 
XUIEditBox RIGHT = 0
 

Function Documentation

◆ Create() [1/2]

function XUIEditBox Create ( )

创建并返回一个空的控件实例的指针

Returns
XUIEditBox 控件指针

◆ Create() [2/2]

function XUIEditBox Create ( strNormalTexture  ,
eTextureType   
)

创建一个固定大小的编辑框

Parameters
strNormalTexturestring 常态纹理图片
eTextureTypenumber 纹理类型,相对路径/绝对路径
Returns
XUIEditBox 一个编辑框对象指针,只有当你对返回对象调用retain的时候才需要调用release

◆ Draw()

function XUIEditBox Draw ( pWorld  ,
unParentFlags   
)

重写这个方法来绘制你自己的节点

Parameters
pWorldIXRenderSet 给定的世界指针
unParentFlagsnumber 渲染器标签
Returns
void

◆ EditBoxReturnKeyPressed()

function XUIEditBoxDelegateLambda EditBoxReturnKeyPressed ( pEditBox  ,
strText  ,
eType   
)

XUIEditBoxDelegateLambda_EditBoxReturnKeyPressed00

Parameters
pEditBoxXUIEditBox
strTextstring
eTypenumber
Returns
void

◆ EndEditingWhenLostFocus()

function XUIEditBox EndEditingWhenLostFocus ( bSet  )

是否在EditBox失去焦点时结束编辑

Parameters
bSetboolean true:立即结束,false:不会结束。
Returns
void

◆ ForceEndEditing()

function XUIEditBox ForceEndEditing ( )

结束输入,并不需要手动调用

Returns
void

◆ GetDelegate()

function XUIEditBox GetDelegate ( )

获取编辑框控件的代理类

Returns
XUIEditBoxDelegate

◆ GetFontColor()

function XUIEditBox GetFontColor ( )

获取编辑框的字体颜色。

Returns
XCOLORBASE 字体颜色

◆ GetFontName()

function XUIEditBox GetFontName ( )

获取编辑框的字体的名字。

Returns
string 字体名称

◆ GetFontSize()

function XUIEditBox GetFontSize ( )

获取编辑框的字体的大小。

Returns
number 字体大小

◆ GetImage()

function XUIEditBox GetImage ( )

获取图片

Returns
XUIImage

◆ GetInputFlag()

function XUIEditBox GetInputFlag ( )

获取编辑框的输入标识

Returns
number 输入标识

◆ GetInputMode()

function XUIEditBox GetInputMode ( )

获取编辑框的输入模式

Returns
number 输入模式

◆ GetMaxLength()

function XUIEditBox GetMaxLength ( )

获取编辑框允许输入的最大长度

Returns
number 最大长度

◆ GetPlaceholderFontColor()

function XUIEditBox GetPlaceholderFontColor ( )

获取占位符的字体颜色

Returns
XCOLORBASE 字体颜色

◆ GetPlaceholderFontName()

function XUIEditBox GetPlaceholderFontName ( )

获取占位符的字体名称

Returns
string 字体名称

◆ GetPlaceholderFontSize()

function XUIEditBox GetPlaceholderFontSize ( )

获取占位符的字体大小

Returns
number 字体大小

◆ GetPlaceholderText()

function XUIEditBox GetPlaceholderText ( )

获取占位符文本内容

Returns
string 占位符文本字符串

◆ GetPositionYAfterKeyBoardShow()

function XUIEditBox GetPositionYAfterKeyBoardShow ( )

只有在IOS下启用的接口,并不需要手动调用。获取在键盘弹起之后,跟随弹起控件的Y值。

Returns
number

◆ GetPositionYBeforeKeyBoardShow()

function XUIEditBox GetPositionYBeforeKeyBoardShow ( )

只有在IOS下启用的接口,并不需要手动调用。获取在键盘弹起之前,跟随弹起控件的Y值。

Returns
number

◆ GetReturnType()

function XUIEditBox GetReturnType ( )

获取编辑框的键盘的Return类型

Returns
number Return类型

◆ GetText()

function XUIEditBox GetText ( )

设置编辑框中输入的文本

Returns
string 给定的文本字符串

◆ GetTextHorizontalAlignment()

function XUIEditBox GetTextHorizontalAlignment ( )

获取文本水平对齐方式

Returns
number eAlignmentXUI_TH_LEFT:左对齐,XUI_TH_CENTER:居中,XUI_TH_RIGHT:右对齐

◆ GetTexture()

function XUIEditBox GetTexture ( )

获取纹理

Returns
string 获取纹理路径名

◆ IsFollowKeyBoardMoved()

function XUIEditBox IsFollowKeyBoardMoved ( )

只有在IOS下启用的接口,获取当前EditBox是否会随IOS键盘弹出而移动。

Returns
boolean 返回当前EditBox是否会随IOS键盘弹出而移动。

◆ LoadTexture()

function XUIEditBox LoadTexture ( strTexture  ,
eTextureType   
)

加载纹理

Parameters
strTexturestring 纹理路径
eTextureTypenumber 纹理类型
Returns
void

◆ new()

function XUIEditBox new ( )

XUIEditBox_new00

Returns
XUIEditBox

XUIEditBoxDelegate_new00

Returns
XUIEditBoxDelegate

XUIEditBoxDelegateLambda_new00

Returns
XUIEditBoxDelegateLambda

◆ OnEnter()

function XUIEditBox OnEnter ( )

事件回调函数 每次当Node进入“stage”时才调用事件回调。 如果Node进入“stage”状态时伴随着一个转换(transition), 那么事件将会在这个转换开始的时候被调用。 在onEnter过程中,你不能够接入“sister/brother”兄妹节点。 如果你重写了onEnter方法,你应该调用它的父类.

Returns
void

◆ OnExit()

function XUIEditBox OnExit ( )

事件回调函数 每次当Node离开“stage”时才调用事件回调。 如果Node离开“stage”状态时伴随着一个转换(transition), 那么事件将会在这个转换结束的时候被调用。 在onEnter过程中中你不能够接入一个兄妹节点。 如果你重写onExit, 你应该调用它的父类,

Returns
void

◆ OnFocusLost()

function XUIEditBox OnFocusLost ( )

重载该函数,以响应EditBox失去焦点时的事件。

Returns
void

◆ OnKeyBoardHide()

function XUIEditBox OnKeyBoardHide ( )

用于让EditBox 平滑隐藏,并不需要手动调用

Returns
void

◆ OnKeyBoardShow()

function XUIEditBox OnKeyBoardShow ( fKeyBoardHeight  ,
fDelta   
)

用于让EditBox 平滑上移,并不需要手动调用

Parameters
fKeyBoardHeightnumber
fDeltanumber
Returns
void

◆ SetAnchorPoint()

function XUIEditBox SetAnchorPoint ( vAnchorPoint  )

设置锚点,用百分比表示。 一个锚点是所有的转换和定位操作发生的点。 它就像在节点上连接其父类的大头针。 锚点是标准化的,就像百分比一样。(0,0)表示左下角,(1,1)表示右上角。 但是你可以使用比(1,1,)更高的值或者比(0,0)更低的值。 默认的锚点是(0.5,0.5),因此它开始于节点的中心位置

Parameters
vAnchorPointXVECTOR2 节点的锚点
Returns
void

◆ SetContentSize()

function XUIEditBox SetContentSize ( vSize  )

设置不转换节点的大小。 contentSize依然是相同的,无论节点是缩放或者旋转。 所有的节点都有大小。图层和场景有相同的屏幕大小。

Parameters
vSizeXVECTOR2 未转换节点的大小
Returns
void

◆ SetDelegate()

function XUIEditBox SetDelegate ( pDelegate  )

设置编辑框控件的代理类

Parameters
pDelegateXUIEditBoxDelegate
Returns
void

◆ SetFollowKeyBoardMoved()

function XUIEditBox SetFollowKeyBoardMoved ( bFollow  )

只有在IOS下启用的接口,设置EditBox是否随键盘弹出而移动,以保证EditBox不会被IOS键盘遮挡。

Parameters
bFollowboolean 是否在IOS键盘弹出时跟随移动。
Returns
void

◆ SetFollowKeyBoardMovedNode()

function XUIEditBox SetFollowKeyBoardMovedNode ( pNode  )

只有在IOS下启用的接口,若EditBox会跟随IOS键盘弹出而移动,那么指定pNode代替EditBox移动。

Parameters
pNodeXUINode 为空值时,EditBox自身跟随键盘弹起而上移。不为空值时,pNode控件代替EditBox跟随键盘弹起而上移。一般会将EditBox的某个祖宗节点传入,来保证所有的兄弟姐妹控件会一起随IOS键盘上移。
Returns
void

◆ SetFont()

function XUIEditBox SetFont ( strFont  ,
nFontSize   
)

设置编辑框的字体。仅支持系统字体

Parameters
strFontstring 字体名称
nFontSizenumber 字体大小
Returns
void

◆ SetFontColor()

function XUIEditBox SetFontColor ( color  )

设置编辑框的字体颜色。

Parameters
colorXCOLORBASE 字体颜色
Returns
void

◆ SetFontName()

function XUIEditBox SetFontName ( strFont  )

设置编辑框的字体的名字。仅支持系统字体

Parameters
strFontstring 字体名称
Returns
void

◆ SetFontSize()

function XUIEditBox SetFontSize ( nFontSize  )

设置编辑框的字体的大小。仅支持系统字体

Parameters
nFontSizenumber 字体大小
Returns
void

◆ SetInputFlag()

function XUIEditBox SetInputFlag ( eInputFlag  )

设置编辑框的输入标识,这个标识是EditBox::InputFlag类型

Parameters
eInputFlagnumber 输入标识
Returns
void

◆ SetInputMode()

function XUIEditBox SetInputMode ( eInputMode  )

设置编辑框的输入模式

Parameters
eInputModenumber 输入模式
Returns
void

◆ SetMaxLength()

function XUIEditBox SetMaxLength ( nMaxLength  )

设置编辑框允许输入的最大长度。 设置这个值默认允许多行输入 可以在Android,iOS和Windows Phone平台使用

Parameters
nMaxLengthnumber 最大长度
Returns
void

◆ SetPlaceholderFont()

function XUIEditBox SetPlaceholderFont ( strFont  ,
nFontSize   
)

设置占位符的字体。仅支持系统字体

Parameters
strFontstring 字体名称
nFontSizenumber 字体大小
Returns
void

◆ SetPlaceholderFontColor()

function XUIEditBox SetPlaceholderFontColor ( color  )

设置占位符的字体颜色

Parameters
colorXCOLORBASE 字体颜色
Returns
void

◆ SetPlaceholderFontName()

function XUIEditBox SetPlaceholderFontName ( strFont  )

设置占位符的字体名称

Parameters
strFontstring 字体名称
Returns
void

◆ SetPlaceholderFontSize()

function XUIEditBox SetPlaceholderFontSize ( nFontSize  )

设置占位符的字体大小

Parameters
nFontSizenumber 字体大小
Returns
void

◆ SetPlaceholderText()

function XUIEditBox SetPlaceholderText ( strText  )

设置占位符文本内容

Parameters
strTextstring 文本字符串
Returns
void

◆ SetPosition()

function XUIEditBox SetPosition ( vPos  )

设置控件位置(x,y)

Parameters
vPosXVECTOR2 位置(x,y)
Returns
void

◆ SetReturnType()

function XUIEditBox SetReturnType ( eReturnType  )

设置编辑框的键盘的Return类型,这个类型的取值为EditBox::KeyboardReturnType常量之一

Parameters
eReturnTypenumber Return类型
Returns
void

◆ SetText()

function XUIEditBox SetText ( strText  )

设置编辑框中输入的文本

Parameters
strTextstring 给定的文本字符串
Returns
void

◆ SetTextHorizontalAlignment()

function XUIEditBox SetTextHorizontalAlignment ( eAlignment  )

设置文本水平对齐方式

Parameters
eAlignmentnumber XUI_TH_LEFT:左对齐,XUI_TH_CENTER:居中,XUI_TH_RIGHT:右对齐
Returns
void

◆ SetVisible()

function XUIEditBox SetVisible ( bVisible  )

设置节点是否可见。默认值是true,一个节点默认是可见的

Parameters
bVisibleboolean 是否可见
Returns
void

◆ TouchDownAction()

function XUIEditBox TouchDownAction ( pNode  ,
controlEvent   
)

当下拉项被点击时执行的事件,不需要手动调用。

Parameters
pNodeXUINode
controlEventnumber
Returns
void

◆ Update()

function XUIEditBox Update ( fDelta  )

如果"scheduleUpdate"被调用并且这个节点是活跃的话,update方法将会被每帧自动调用 ,通过重载该函数的方式在每一帧处理自定义事件。

Parameters
fDeltanumber 与上一帧Tick函数的间隔时间。
Returns
void

Variable Documentation

◆ CENTER

XUIEditBox CENTER = 0

◆ LEFT

XUIListView LEFT = 0

◆ RIGHT

XUIListView RIGHT = 0

◆ XUI_ANY

XUIEditBox XUI_ANY = 0

◆ XUI_DECIMAL

XUIEditBox XUI_DECIMAL = 0

◆ XUI_DEFAULT

XUIEditBox XUI_DEFAULT = 0

◆ XUI_DONE

XUIEditBox XUI_DONE = 0

◆ XUI_EMAIL_ADDRESS

XUIEditBox XUI_EMAIL_ADDRESS = 0

◆ XUI_GO

XUIEditBox XUI_GO = 0

◆ XUI_INITIAL_CAPS_ALL_CHARACTERS

XUIEditBox XUI_INITIAL_CAPS_ALL_CHARACTERS = 0

◆ XUI_INITIAL_CAPS_SENTENCE

XUIEditBox XUI_INITIAL_CAPS_SENTENCE = 0

◆ XUI_INITIAL_CAPS_WORD

XUIEditBox XUI_INITIAL_CAPS_WORD = 0

◆ XUI_LOWERCASE_ALL_CHARACTERS

XUIEditBox XUI_LOWERCASE_ALL_CHARACTERS = 0

◆ XUI_NEXT

XUIEditBox XUI_NEXT = 0

◆ XUI_NUMERIC

XUIEditBox XUI_NUMERIC = 0

◆ XUI_PASSWORD

XUIEditBox XUI_PASSWORD = 0

◆ XUI_PHONE_NUMBER

XUIEditBox XUI_PHONE_NUMBER = 0

◆ XUI_SEARCH

XUIEditBox XUI_SEARCH = 0

◆ XUI_SEND

XUIEditBox XUI_SEND = 0

◆ XUI_SENSITIVE

XUIEditBox XUI_SENSITIVE = 0

◆ XUI_SINGLE_LINE

XUIEditBox XUI_SINGLE_LINE = 0

◆ XUI_URL

XUIEditBox XUI_URL = 0

◆ XUIEditBox

XUIEditBox = {}