Child pages
  • TextField

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientsWordListMobileClient

servoy sSummary12%30%58%height: 30px;3Property SummaryEnables a component to stick to a specific side of form and/or to grow or shrink when a window is resized.The background color of the component.The type, color and style of border of the component.Thecss position of the component.The dataprovider of the component.Property to get and add design-time properties for a component.The type of display used by the field.Flag that enables or disables merging of data inside components using tags (placeholders).Flag that tells if the content of the field can be edited or not.The enable state of the component, default true.The font type of the component.The foreground color of the component.Form index returns the z-index of the form element.The format that should be applied when displaying the data in the component.Horizontal alignment of the text inside the component.The x and y position of the component, in pixels, separated by a comma.The margins of the component.The name of the component.The text that is displayed in field when the field doesn't have a text value.Enables an element to resize based on its content and/or move when printing.Flag that tells if the component should be printed or not when the form is printed.Flag that tells if the content of the field should be automatically selected when the field receives focus.The width and height (in pixels), separated by a comma.The name of the style class that should be applied to this component.An index that specifies the position of the component in the tab sequence.Flag for header text to field component that enables or disables merging of data inside components using tags (placeholders).Header text to componentThe text displayed when hovering over the component with a mouse cursor.Flag that tells if the component is transparent or not.The valuelist that is used by this field when displaying data.The visible property of the component, default true.

servoy sSummary12%30%58%height: 30px;3Event SummaryvoidThe method that is executed when the component is clicked.Method that is executed when the data in the component is successfully changed.voidThe method that is executed when the component gains focus.voidThe method that is executed when the component looses focus.voidThe method that is executed when the component is rendered.voidThe method that is executed when the component is right clicked.

propertyservoy sDetail2100%height:30px2Property Detailsanchorsbackgroundname

anchors

background

dessIndent
Enables
The 
a
background 
component
color 
to
of 
stick to a specific side of form and/or to grow or shrink when a window is resized. If opposite anchors are activated then the component with grow or shrink with the window. For example if Top and Bottom are activated, then the component will grow/shrink when the window is vertically resized. If Left and Right are activated then the component will grow/shrink when the window is horizontally resized. If opposite anchors are not activated, then the component will keep a constant distance from the sides of the window which correspond to the activated anchors.ret

Returns

sIndentclients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowbackgroundname

background

dessIndent
The background color of the component.
the component.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
borderTypename

borderType

dessIndent
The type, color and style 
of border of the component.ret

Returns

sIndentclients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowcssPositionname

cssPosition

dessIndentThecss position
of border of the component.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
dataProvidername

dataProvider

dessIndent
The dataprovider of the component.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
designTimePropertiesname

designTimeProperties

dessIndent
Property to get and add design-time properties for a component.
ret

Returns

sIndent map of the design-time properties
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
displayTypename

displayType

dessIndent
The type of display used by the field. Can be one of CALENDAR, CHECKS,
COMBOBOX, HTML_AREA, IMAGE_MEDIA, PASSWORD, RADIOS, RTF_AREA, TEXT_AREA,
TEXT_FIELD, TYPE_AHEAD, LIST_BOX, MULTISELECT_LISTBOX or SPINNER.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
displaysTagsname

displaysTags

dessIndent
Flag that enables or disables merging of data inside components using tags (placeholders).
Tags (or placeholders) are words surrounded by %% on each side. There are data tags and
standard tags. Data tags consist in names of dataproviders surrounded by %%. Standard tags
are a set of predefined tags that are made available by the system.

See the "Merging data" section for more details about tags.

The default value of this flag is "false", that is merging of data is disabled by default.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
editablename

editable

dessIndent
Flag that tells if the content of the field can be edited or not.
The default value of this flag is "true", that is the content can be edited.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
enabledname

enabled

dessIndent
The enable state of the component, default true.
ret

Returns

sIndent enabled state
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
fontTypename

fontType

dessIndent
The font type of the component.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
foregroundname

foreground

dessIndent
The foreground color of the component.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
formIndexname

formIndex

dessIndent
Form index returns the z-index of the form element. If two elements overlap,
then the element with higher Z index is displayed above the form element with lower Z index.
In case of form inheritance, form index is evaluated in the context (form) where property is defined.
Elements which have child form as context will always be on top of elements which have parent form.
If element is overridden in child form but form index property is still inherited its context is still parent form.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
formatname

format

dessIndent
The format that should be applied when displaying the data in the component.
There are different options for the different dataprovider types that are assigned to this field.
For Integer fields, there is a display and an edit format, using http://docs.oracle.com/javase/7/docs/api/java/text/DecimalFormat.html and the max (string) length can be set.
For Text/String fields, there are options to force uppercase,lowercase or only numbers. Or a mask can be set that restrict the input the pattern chars can be found here: http://docs.oracle.com/javase/7/docs/api/javax/swing/text/MaskFormatter.html
A mask can have a placehoder (what is shown when there is no data) and if the data must be stored raw (without literals of the mask). A max text length can also be set to force
the max text length input, this doesn't work on mask because that max length is controlled with the mask.
For Date fields a display and edit format can be set by using a pattern from here: http://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html, you can also say this must behave like a mask (the edit format)
A mask only works with when the edit format is exactly that mask (1 char is 1 number/char), because for example MM then only 2 numbers are allowed MMM that displays the month as a string is not supported as a mask.
Some examples are "dd-MM-yyyy", "MM-dd-yyyy", etc.
The format property is also used to set the UI Converter, this means that you can convert the value object to something else before it gets set into the field, this can also result in a type change of the data. 
So a string in scripting/db is converted to a integer in the ui, then you have to set an integer format. 
This property is applicable only for types: TEXT_FIELD, COMBOBOX, TYPE_AHEAD, CALENDAR and SPINNER.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
horizontalAlignmentname

horizontalAlignment

dessIndent
Horizontal alignment of the text inside the component. Can be one of
LEFT, CENTER or RIGHT.

Note that
this property does not refer to the horizontal alignment of the component inside the form.ret

Returns

sIndentclients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowlocationname

location

dessIndentThe x and y position of the component, in pixels, separated by a comma
 this property does not refer to the horizontal alignment
of the component inside the form.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
,MobileClientsam

Sample

sIdentjavascript
lastDetailRow
marginname

margin

dessIndent
The margins of the component. They are specified in this order, 
separated by commas: top, left, bottom, right.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
namename

name

dessIndent
The name of the component. Through this name it can also accessed in methods.
Must be a valid javascript name. (no - in the name or start with number)
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
placeholderTextname

placeholderText

dessIndent
The text that is displayed in field when the field doesn't have a text value.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
printSlidingname

printSliding

dessIndent
Enables an element to resize based on its content and/or move when printing.
The component can move horizontally or vertically and can grow or shrink in
height and width, based on its content and the content of neighboring
components.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
printablename

printable

dessIndent
Flag that tells if the component should be printed or not when the form is printed.

By default components are printable.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
selectOnEntername

selectOnEnter

dessIndent
Flag that tells if the content of the field should be automatically selected
when the field receives focus. The default value of this field is "false".
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
sizename

size

dessIndent
The width and height (in pixels), separated by a comma.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
styleClassname

styleClass

dessIndent
The name of the style class that should be applied to this component.

When defining style classes for specific component types, their names
must be prefixed according to the type of the component. For example 
in order to define a class names 'fancy' for fields, in the style
definition the class must be named 'field.fancy'. If it would be 
intended for labels, then it would be named 'label.fancy'. When specifying
the class name for a component, the prefix is dropped however. Thus the
field or the label will have its styleClass property set to 'fancy' only.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
tabSeqname

tabSeq

dessIndent
An index that specifies the position of the component in the tab sequence. The components 
are put into the tab sequence in increasing order of this property. A value of 0 means
to use the default mechanism of building the tab sequence (based on their location on the form).
A value of -2 means to remove the component from the tab sequence.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
titleDisplaysTagsname

titleDisplaysTags

dessIndent
Flag for header text to field component that enables or disables merging of data inside components using tags (placeholders).
Tags (or placeholders) are words surrounded by %% on each side. There are data tags and
standard tags. Data tags consist in names of dataproviders surrounded by %%. Standard tags
are a set of predefined tags that are made available by the system.

See the "Merging data" section for more details about tags.

The default value of this flag is "false", that is merging of data is disabled by default.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
titleTextname

titleText

dessIndent
Header text to component
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
toolTipTextname

toolTipText

dessIndent
The text displayed when hovering over the component with a mouse cursor.

NOTE:
HTML should be used for multi-line tooltips; you can also use any
valid HTML tags to format tooltip text. For example:
<html>This includes<b>bolded text</b> and
<font color='blue'>BLUE</font> text as well.</html>
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
transparentname

transparent

dessIndent
Flag that tells if the component is transparent or not.

The default value is "false", that is the components
are not transparent.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
valuelistname

valuelist

dessIndent
The valuelist that is used by this field when displaying data. Can be used
with fields of type CHECKS, COMBOBOX, RADIOS and TYPE_AHEAD.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
visiblename

visible

dessIndent
The visible property of the component, default true.
ret

Returns

sIndent visible property
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow

eventservoy sDetail2100%height:30px2Event DetailsonActionname

onAction()

dessIndent
The method that is executed when the component is clicked.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRowonDataChangename

onDataChange(oldValue, newValue, event)

dessIndent
Method that is executed when the data in the component is successfully changed.
prs

Parameters

sIndentoldValueold valuenewValuenew valueeventthe event that triggered the action
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
onFocusGainedname

onFocusGained(event)

dessIndent
The method that is executed when the component gains focus.
NOTE: Do not call methods that will influence the focus itself.
prs

Parameters

sIndenteventthe event that triggered the action
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
onFocusLostname

onFocusLost(event)

dessIndent
The method that is executed when the component looses focus.
prs

Parameters

sIndenteventthe event that triggered the action
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
onRendername

onRender()

dessIndent
The method that is executed when the component is rendered.
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
onRightClickname

onRightClick(event)

dessIndent
The method that is executed when the component is right clicked.
prs

Parameters

sIndenteventthe event that triggered the action
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow