Child pages
  • JSWebComponent

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 ClientssWordListNGClient

servoy sReturnTypes2100%height: 30px;2ExtendssWordListBLOCK

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 enable state of the component, default true.The Z index of this component.The height in pixels of the component.The name of the component.The webcomponent type (name from the spec).The visible property of the component, default true.The width in pixels of the component.The x coordinate of the component on the form.The y coordinate of the component on the form.

servoy sSummary12%30%58%height: 30px;3Methods SummaryGet a design-time property of an element.Get the design-time properties of an element.Returns the name of the form.Returns the JSMethod handler with the given name.Get the design-time value of the given property.Returns the UUID of this component.Set a design-time property of an element.Clear a design-time property of an element.voidSimilar to resetJSONProperty but for handlers.voidReset the design-time value of the given property.voidSet the JSMethod handler for the given handler name.voidSet the design-time value for the given property.

propertyservoy sDetail2100%height:30px2Property Detailsanchorsname

anchors

dessIndentEnables a component to 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

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow enabledname

enabled

dessIndentThe enable state of the component, default true.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
formIndexname

formIndex

dessIndentThe Z index of this component. If two components overlap, then the component with higher Z index is displayed above the component with lower Z index.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
heightname

height

dessIndentThe height in pixels of the component.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
namename

name

dessIndentThe name of the component. Through this name it can also accessed in methods.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
typeNamename

typeName

dessIndentThe webcomponent type (name from the spec).ret

Returns

sIndent
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow 
visiblename

visible

dessIndentThe visible property of the component, default true.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
widthname

width

dessIndentThe width in pixels of the component.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
xname

x

dessIndentThe x coordinate of the component on the form.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
yname

y

dessIndentThe y coordinate of the component on the form.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 

functionservoy sDetail2100%height:30px2Methods DetailsgetDesignTimePropertyname

getDesignTimeProperty(key)

dessIndentGet a design-time property of an element.prs

Parameters

sIndentkeythe name of the property
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow getDesignTimePropertyNamesname

getDesignTimePropertyNames()

dessIndentGet the design-time properties of an element.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
getFormNamename

getFormName()

dessIndentReturns the name of the form. (may be empty string as well)ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
getHandlername

getHandler(handlerName)

dessIndentReturns the JSMethod handler with the given name.prs

Parameters

sIndenthandlerNamethe name of the handler to get
ret

Returns

sIndent
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow 
getJSONPropertyname

getJSONProperty(propertyName)

dessIndentGet the design-time value of the given property.prs

Parameters

sIndentpropertyNamethe name of the property to get
ret

Returns

sIndent
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow 
getUUIDname

getUUID()

dessIndentReturns the UUID of this component.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
putDesignTimePropertyname

putDesignTimeProperty(key, value)

dessIndentSet a design-time property of an element.prs

Parameters

sIndentkeythe name of the propertyvaluethe value to store
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
removeDesignTimePropertyname

removeDesignTimeProperty(key)

dessIndentClear a design-time property of an element.prs

Parameters

sIndentkeythe name of the property
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
resetHandlername

resetHandler(handlerName)

dessIndentSimilar to resetJSONProperty but for handlers.prs

Parameters

sIndenthandlerNamethe name of the handler to reset
ret

Returns

sIndentclients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow 
resetJSONPropertyname

resetJSONProperty(propertyName)

dessIndentReset the design-time value of the given property. This makes it as if it was never set. It can be useful when working with form inheritance.prs

Parameters

sIndentpropertyNamethe name of the property to reset
ret

Returns

sIndentclients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow 
setHandlername

setHandler(handlerName, method)

dessIndentSet the JSMethod handler for the given handler name. The handlerName is checked for existence in the component spec file, if the component does not declare this handler, an error is thrown. If the handler is already set, it will be replaced with the new JSMethod.prs

Parameters

sIndenthandlerNamethe name of the handler to getmethodthe JSMethod to attach to the handler (can be also JSMethod that has arguments)
ret

Returns

sIndentclients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow 
setJSONPropertyname

setJSONProperty(propertyName, value)

dessIndentSet the design-time value for the given property. For primitive property types you can just set the value. For more complex property types you can set a JSON value similar to what would be generated in the .frm file if you would design what you need using editor/properties view. Some property types can be assigned values in the runtime accepted format (for example border, font typed properties have a string representation at runtime and here as well).prs

Parameters

sIndentpropertyNamethe name of the property to setvaluethe new value of the property
ret

Returns

sIndentclients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow