ToolDef

(esrith/amos/core/ToolDef)

ToolDef is a class to define configurations of tool in ResultList such as; type, align, tooltip settings of tools.

Description
new ToolDef()

Create a new ToolDef object.

Description
ALIGN_BOTTOM

ALIGN_BOTTOM: bottom

ALIGN_LEFT

ALIGN_LEFT: left

ALIGN_RIGHT

ALIGN_RIGHT: right

ALIGN_TOP

ALIGN_TOP: top

TYPE_BUFFER

TYPE_BUFFER: buffer

TYPE_CHECKBOX

TYPE_CHECKBOX: checkbox

TYPE_DELETE

TYPE_DELETE: delete

TYPE_DOMNODE

TYPE_DOMNODE: domnode

TYPE_EDIT

TYPE_EDIT: edit

TYPE_IMAGEBUTTON

TYPE_IMAGEBUTTON: imagebutton

TYPE_ROUTING

TYPE_ROUTING: routing

TYPE_TEXT

TYPE_TEXT: text

Type Description
align String

Align of element. (can use constant)

fieldName String

Field name where data is stored. This may be from a JSON file or a stored procedure response.

image Object

If 'toolType' is TYPE_IMAGEBUTTON must be require image. This Object contains 2 values.

image.normal String

default normal image

image.over String

default over image

label String

Label of text. If 'toolType' is TYPE_TEXT must be require.

toolClass String

css classname for tool.

tooltip String

Tooltip of icon button.

toolType String

Type of tool. (See constants.)

Return type Description
_preparingColumn(tools) None
Constructors Detail
new ToolDef()

Create a new ToolDef object.

constants Detail
<String>
ALIGN_BOTTOM

ALIGN_BOTTOM: bottom

<String>
ALIGN_LEFT

ALIGN_LEFT: left

<String>
ALIGN_RIGHT

ALIGN_RIGHT: right

<String>
ALIGN_TOP

ALIGN_TOP: top

<String>
TYPE_BUFFER

TYPE_BUFFER: buffer

<String>
TYPE_CHECKBOX

TYPE_CHECKBOX: checkbox

<String>
TYPE_DELETE

TYPE_DELETE: delete

<String>
TYPE_DOMNODE

TYPE_DOMNODE: domnode

<String>
TYPE_EDIT

TYPE_EDIT: edit

<String>
TYPE_IMAGEBUTTON

TYPE_IMAGEBUTTON: imagebutton

<String>
TYPE_ROUTING

TYPE_ROUTING: routing

<String>
TYPE_TEXT

TYPE_TEXT: text

Properties Detail
<String>
align

Align of element. (can use constant)

<String>
fieldName

Field name where data is stored. This may be from a JSON file or a stored procedure response.

<Object>
image

If 'toolType' is TYPE_IMAGEBUTTON must be require image. This Object contains 2 values.

Sub-properties:

  • <String> normal Required

    Path to normal image.

  • <String> over Required

    Path to over image.

<String>
image.normal

default normal image

<String>
image.over

default over image

<String>
label

Label of text. If 'toolType' is TYPE_TEXT must be require.

<String>
toolClass

css classname for tool.

<String>
tooltip

Tooltip of icon button.

<String>
toolType

Type of tool. (See constants.)

Methods Detail
_preparingColumn
(
  • tools
)
Parameters