DisplayBox component

Availability

Flash Player 7.

Description

This component will allow you to construct a multi column box with multiple image support. You can add any number of displayable columns as well as hidden columns that which will allow you to keep needed associated data for quick retrieval. The ability to set the columns as editable, html displayable, and word wrapping is also included. The component allows you to manulally set the size, but also gives you the ability to have it resize itself. You can add any number of images on each row and specify if they are clickable. You can access events from image clicking, row selection, column header selection, and mouse events.

Method summary for the DisplayBox component

Method

Description

DisplayBox.addColumnImage()

Adds a library image to a column header

DisplayBox.addItemImage()

Adds a library image to a row

DisplayBox.addListItem()

Adds a new row

DisplayBox.clearList()

Removes all rows from the DisplayBox

DisplayBox.deleteItem()

Deletes a row

DisplayBox.findItem()

Will locate all rows matching the supplied criteria highlighting the row or returning the index ID's

DisplayBox.getItemValue()

Returns the value stored in the request field of the requested row

DisplayBox.GetSelected()

Returns an array of the selected or unselected rows

DisplayBox.InitBox() Constructs the DisplayBox

DisplayBox.newColumn()

Adds a new column above and beyond any defined in the GUI

DisplayBox.removeColumnImage()

Removes the specified image from the specified column header

DisplayBox.removeItemImage()

Removes the specified image from the specified row

DisplayBox.selectAll()

Highlights or clears the selection of all rows based upon the parameter supplied

DisplayBox.SetColumnProperty()

Allows you to set a couple extra parameters specific to a column in a particular row

DisplayBox.SetEditOff()

Takes a row out of user edit mode, will also return a boolean stating if the row data was changed

DisplayBox.SetEditOn()

Places a row into user edit mode

DisplayBox.setItemValue()

Sets the text in a field for the specified row

DisplayBox.setRollOver()

Sets or changes the rollover text for an image, row or column header

DisplayBox.showItem()

Scrolls the requested row, ensuring it is visible to the user

Event summary for the DisplayBox component

Listener

Description

DisplayBox.ColumnClick()

Invoked when a column header is clicked

DisplayBox.ColumnImageClick()

Invoked when an image in a column header is clicked

DisplayBox.DoubleClick()

Invoked when a row is double clicked

DisplayBox.EditChange()

Invoked when an editable row has been edited after another row is selected

DisplayBox.ImageClick()

Invoked when an image in a row is clicked

DisplayBox.MouseOut()

Invoked when the mouse leaves a row

DisplayBox.MouseOver()

Invoked when the mouse is over a row

DisplayBox.SingleClick()

Invoked when a row is single clicked

Property summary for the DisplayBox component

Property

Description

DisplayBox.AutoEdit

If set to true, the row will automatically enter user edit mode when a row is selected

DisplayBox.autoResize

Will resize the width of the box based upon the definition of the columns

DisplayBox.BackColor

Sets the background color of the box, a -1 will make the background transparent

DisplayBox.CurrentSelection

Returns the ID of the currently selected row

DisplayBox.DisplayRows

Will automatically resize the height of the box to ensure the number of rows are visible, supplying a 0 will disable the automatic height resize

DisplayBox.HighlightColor

The background row color displayed when a row has the mouse over it

DisplayBox.LockRollX

Will lock the X position of the tooltip window to this value, -1 disables this

DisplayBox.LockRollY

Will lock the Y position of the tooltip window to this value, -1 disables this

DisplayBox.MultiSelect

If set to true, allows the user to select multiple rows at once

DisplayBox.rowCount

The total number of rows currently loaded

DisplayBox.RowHeight

The height of each row

DisplayBox.SelectionColor

The background row color displayed when a row is selected

Availability

Flash Player 7.

Example

See also

Author

Telsim, Inc.