Portal
(part of package 'Servoy Core') Extends designtime/SolutionModel: JSWebComponent Extends runtime: RuntimeWebComponent
This is a reference page; many components have detailed usage guides here.
Properties
background
Type: Color
borderType
Type: Border
editable
Type: Boolean Default Value: true
enabled
Type: Enabled Default Value: true
foreground
Type: Color
headerHeight
Type: Number Default Value: 32
initialSort
Type: String
intercellSpacing
Type: Dimension
location
Type: Point
multiLine
Type: Boolean
readOnlyMode
Type: Protected Default Value: null
relatedFoundset
Type: JSFoundset
reorderable
Type: Boolean
resizable
Type: Boolean
resizeble
Type: Boolean
rowBGColorCalculation
Type: String
rowHeight
Type: Number
scrollbars
Type: Scrollbars
showHorizontalLines
Type: Boolean
showVerticalLines
Type: Boolean
sortable
Type: Boolean
styleClass
Type: String
tabSeq
Type: Tabseq
transparent
Type: Boolean
visible
Type: Visible
Events
onDragEndMethodID(event)
Parameters:
{JSDNDEvent} event
onDragMethodID(event)
@return {int}
Parameters:
{JSDNDEvent} event
Returns: {Number}
onDragOverMethodID(event)
@return {boolean}
Parameters:
{JSDNDEvent} event
Returns: {Boolean}
onDropMethodID(event)
@return {boolean}
Parameters:
{JSDNDEvent} event
Returns: {Boolean}
API
deleteRecord()
Deletes the currently selected record from the portal's foundset.
duplicateRecord(addOnTop)
Duplicates the currently selected record in the portal's foundset.
Parameters:
{Boolean} [addOnTop] Whether to add the duplicated record at the top of the foundset.
getFormName()
Retrieves the name of the form that the portal is associated with.
Returns: String The name of the form containing the portal.
getHeight()
Retrieves the height of the portal component.
Returns: Number The height of the portal in pixels.
getLocationX()
Retrieves the X-coordinate (horizontal position) of the portal component.
Returns: Number The X-coordinate of the portal in pixels.
getLocationY()
Retrieves the Y-coordinate (vertical position) of the portal component.
Returns: Number The Y-coordinate of the portal in pixels.
getMaxRecordIndex()
Retrieves the maximum record index available in the portal's foundset.
Returns: Number The total number of records in the related foundset.
getScrollX()
Retrieves the current horizontal scroll position of the portal.
Returns: Number The horizontal scroll position in pixels. Always returns 0, as scrolling is not implemented for web.
getScrollY()
Retrieves the current vertical scroll position of the portal.
Returns: Number The vertical scroll position in pixels. Always returns 0, as scrolling is not implemented for web.
getSelectedIndex()
Retrieves the index of the currently selected record in the portal's foundset.
Returns: Number The 1-based index of the selected record, or -1 if no record is selected.
getSortColumns()
Retrieves the sorting columns applied to the portal's related foundset.
Returns: String A string representing the current sort order of the foundset, formatted as a comma-separated list of column names followed by sort directions (ASC or DESC).
getWidth()
Retrieves the width of the portal component.
Returns: Number The width of the portal in pixels.
newRecord(addOnTop)
Creates a new record in the portal's foundset.
Parameters:
{Boolean} [addOnTop] Whether to add the new record at the top of the foundset.
setScroll(x,y)
Sets the scroll position of the portal.
Parameters:
setSelectedIndex(index)
Sets the selected record index in the portal's foundset.
Parameters:
{Number} index The 1-based index of the record to be selected.
Last updated
Was this helpful?