Genero Browser Client User Guide

class to add

adoptChildWidget(widget : WidgetBase, options : Object)
[inherits from WidgetGroupBase]

Add a child widget which has already a parent to the widget

Parameters

widget	WidgetBase	the widget to add
options	Object	possible options
options.noDOMInsert	boolean	won't add child to DOM
options.position	number	insert position
options.ordered	string	auto order item by unique auiID
options.tag	string	context tag
options.mode	string	context mode : null\|"replace"

detach()
[inherits from WidgetBase]

Detach the widget from the dom

emit(type : string, arguments… : any)
[inherits from EventListener]

Emit an event

Parameters

type	string	event type to emit
arguments	any	arguments (excluding type) will be set in event.data

empty()
[inherits from WidgetGroupBase]

Remove all children

getApplicationIdentifier() : (string)
[inherits from WidgetBase]

Get the unique identifier of the application

Returns

(string) the unique identifier of the application

getApplicationWidget() : (ApplicationWidget)
[inherits from WidgetBase]

Get Application Widget related to the widget

Returns

(ApplicationWidget) ApplicationWidget

getBackgroundColor() : (string)
[inherits from ColoredWidgetBase]

Returns the background color

Returns

(string) a color definition as an RGB function ('rgb(128, 255, 0)')

getBuildParameters() : (Object)
[inherits from WidgetBase]

Returns build parameters

Returns

(Object) build parameters

getChildren() : (Array)
[inherits from WidgetGroupBase]

Get all children of this widget

Returns

(Array) the list of children of this widget group

getClassName() : (string)
[inherits from WidgetBase]

Get the main class name of the widget

Returns

(string) the main class name

getColor() : (string)
[inherits from ColoredWidgetBase]

Returns the fore color

Returns

(string) a color definition as an RGB function ('rgb(128, 255, 0)')

getColorFromStyle() : (string)
[inherits from ColoredWidgetBase]

Returns the fore color (directly from style css)

Returns

(string) a color definition as an RGB function ('rgb(128, 255, 0)')

getColumnIndex() : (number)

Returns index of the column in the parent table (vm aui index)

Returns

(number) index of the column in the table

getContainerElement() : (HTMLElement)
[inherits from WidgetGroupBase]

Get the container Element

Returns

(HTMLElement) the element

getCurrentChildren() : (WidgetBase)
[inherits from WidgetGroupBase]

Returns current widget (flagged with 'current' class)

Returns

(WidgetBase) The current child

getDefaultWidth() : (number)

Return the column default width defined in store settings

Returns

(number) default column width

getDialogType() : (string)
[inherits from WidgetBase]

return widget current dialog type

Returns

(string) values can be : Input, InputArray, Display, DisplayArray or Construct

getElement() : (HTMLElement)
[inherits from WidgetBase]

Get the root element of the widget

Returns

(HTMLElement) the root element of the widget

getEnd() : (string)
[inherits from WidgetBase]

Get end (for reversed mode)

Returns

(string) end keyword for rtl

getFontColor() : (string)
[inherits from TextWidgetBase]

Get the font color used by this widget

Returns

(string) a CSS font color value

getFontFamily() : (string)
[inherits from TextWidgetBase]

Get the font-family used by this widget

Returns

(string) the used font family

getFontSize() : (string)
[inherits from TextWidgetBase]

Get the font-size used by this widget

Returns

(string) a CSS font size value

getFontStyle() : (string)
[inherits from TextWidgetBase]

Get the font-style used by this widget

Returns

(string) a CSS font style value

getFontWeight() : (string)
[inherits from TextWidgetBase]

Get the font-family used by this widget

Returns

(string) a CSS font weight value

getFormWidget() : (FormWidget)
[inherits from WidgetBase]

Get the Form Widget related to the widget

Returns

(FormWidget) FormWidget

getIndexOfChild(widget : WidgetBase) : (number)
[inherits from WidgetGroupBase]

Get the child widget position

Parameters

widget

the widget

Returns

(number) widget position

getInitialWidth() : (number)

Returns measured column width

Returns

(number) initial column width

getItem(index : number) : (TableColumnItemWidget)

Returns column item at the specied index (row)

Parameters

index

index of the item (row)

Returns

(TableColumnItemWidget) item widget

getLayoutEngine() : (LayoutEngineBase)
[inherits from WidgetBase]

Get the widget's layout engine

Returns

(LayoutEngineBase) the widget's layout engine

getLayoutInformation() : (LayoutInformation)
[inherits from WidgetBase]

Get the widget's layout information

Returns

(LayoutInformation) the widget's layout information

getName() : (string)
[inherits from WidgetBase]

Get the name of the widget class

Returns

(string) the widget class name

getOrder() : (number)

Returns index order of column

Returns

(number) order index

getOrderedColumnIndex() : (number)

Returns index of the column in the parent table (visual index)

Returns

(number) index of the column in the table

getParentWidget(type : any) : (WidgetGroupBase)
[inherits from WidgetBase]

Get the parent widget

Parameters

type

any

class name to look for

Returns

(WidgetGroupBase) the parent widget

getStart() : (string)
[inherits from WidgetBase]

Get start (for reversed mode)

Returns

(string) start keyword for rtl

getStretchableScrollGridWidgetBase() : (StretchableScrollGridWidgetBase)
[inherits from WidgetBase]

Get the stretchable scrollgrid Widget base class related to the widget

Returns

(StretchableScrollGridWidgetBase) StretchableScrollGridWidgetBase

getStyle(selector : string, property : string, appliesOnRoot : boolean) : (any)
[inherits from WidgetBase]

Get widget style property value

Parameters

selector	string	additional sub selector
property	string	property name
appliesOnRoot	boolean	true if the returned selector should match the root too.

Returns

(any) property value if set, undefined otherwise

getTableWidgetBase() : (TableWidgetBase)
[inherits from WidgetBase]

Get the table Widget base class related to the widget

Returns

(TableWidgetBase) TableWidgetBase

getText() : (string)

Returns column text (title)

Returns

(string) the column text

getTextAlign() : (string)
[inherits from TextWidgetBase]

Get the text-align used by this widget

Returns

(string) a text alignment

getTextDecoration() : (string)
[inherits from TextWidgetBase]

Get the text-decoration used by this widget

Returns

(string) a CSS text decoration

getTextTransform() : (string)
[inherits from TextWidgetBase]

Get the text-transform used by this widget

Returns

(string) a CSS text transform

getTitle() : (string)
[inherits from WidgetBase]

Get the title of the widget

Returns

(string) the tooltip text

getTitleWidget() : (TableColumnTitleWidget)

Returns title widget of the column

Returns

(TableColumnTitleWidget) the title widget

getUniqueIdentifier() : (string)
[inherits from WidgetBase]

Get the unique identifier of the widget

Returns

(string) the unique identifier of the widget

getUserInterfaceWidget() : (UserInterfaceWidget)
[inherits from WidgetBase]

Get the UI widget related to the widget

Returns

(UserInterfaceWidget) UserInterfaceWidget

getWidgetAt(row : number) : (WidgetBase)

Returns widget at the specified row

Parameters

row

row of item

Returns

(WidgetBase) widget

getWidth() : (number)

Returns column width (pixels)

Returns

(number) column width

getWindowWidget() : (WindowWidget)
[inherits from WidgetBase]

Get the Window Widget related to the widget

Returns

(WindowWidget) WindowWidget

hasChildWebComponent() : (boolean)
[inherits from WidgetGroupBase]

returns true if a WebComponent is contained in any sublevel child

Returns

(boolean) true if the widget has webcomponent, false otherwise

hasClass(className : string)
[inherits from WidgetBase]

Checks if the widget element has the given class

Parameters

className

class to check

hasFocus() : (boolean)
[inherits from WidgetBase]

Check if widget node has focus (class gbc_Focus)

Returns

(boolean) true if widget node has focus

hasVMFocus() : (boolean)
[inherits from WidgetBase]

Check if widget node has VM focus

Returns

(boolean) true if widget node has VM focus

ignoreLayout() : (boolean)
[inherits from WidgetBase]

Does the widget ignore layouting

Returns

(boolean) true if the widget ignore all layout.

isAlwaysHidden() : (boolean)

Returns true if column must be always hidden

Returns

(boolean) true if column is always hidden

isAlwaysVisible() : (boolean)

Returns true if column must be always visible

Returns

(boolean) true if column is always visible

isChildOf(parent : WidgetBase) : (boolean)
[inherits from WidgetBase]

Check if this widget is a child of a given one

Parameters

parent

StretchableScrollGridWidgetBase

the reference parent widget

Returns

(boolean) true if is a child, false otherwise

isCurrent() : (boolean)

Check if column is current one

Returns

(boolean) true if the column is the current one, false otherwise

isDestroyed() : (boolean)
[inherits from EventListener]

Returns if the node is destroyed

Returns

(boolean) true if node is destroyed

isEnabled() : (boolean)
[inherits from WidgetBase]

Check if widget is enabled

Returns

(boolean) true if the widget allows user interaction, false otherwise.

isFocusable() : (boolean)
[inherits from WidgetBase]

Returns if the widget is focusable

Returns

(boolean) State of focusable

isFrozen() : (boolean)

Indicates if table has frozen columns

Returns

(boolean) returns true if table has frozen columns

isHidden() : (boolean)
[inherits from WidgetBase]

Check if the widget is hidden

Returns

(boolean) true if the widget is hidden, false otherwise

isInMatrix() : (boolean)
[inherits from WidgetBase]

Check if the widget is in a matrix

Returns

(boolean) true if the widget is in a matrix, false otherwise.

isInScrollGrid(scrollGrid : StretchableScrollGridWidgetBase) : (boolean)
[inherits from WidgetBase]

Check if the widget is in a scrollGrid

Parameters

scrollGrid

specific scrollGrid, if null just return if widget is in any scrollGrid

Returns

(boolean) true if the widget is in a table, false otherwise.

isInTable(table : TableWidgetBase) : (boolean)
[inherits from WidgetBase]

Check if the widget is in a table

Parameters

table

TableWidgetBase

specific table, if null just return if widget is in any table

Returns

(boolean) true if the widget is in a table, false otherwise.

isLeftFrozen() : (boolean)

Indicates if table column is left frozen

Returns

(boolean) returns true if column is left frozen

isMovable() : (boolean)

Returns true if column is movable

Returns

(boolean) true if column is movable

isNoBorder() : (boolean)
[inherits from WidgetBase]

Check if the widget is displayed without border

Returns

(boolean) true if the widget has no border class, false otherwise

isReversed() : (boolean)
[inherits from WidgetBase]

Check if arabic mode is enabled

Returns

(boolean) true if enabled

isRightFrozen() : (boolean)

Indicates if table column is right frozen

Returns

(boolean) returns true if column is right frozen

isSizable() : (boolean)

Returns true if column is sizable

Returns

(boolean) true il column is sizable

isTreeView() : (boolean)

Returns true if column is a tree

Returns

(boolean) true if is a tree

isVisible() : (boolean)
[inherits from WidgetBase]

Check if the widget is visible

Returns

(boolean) true if visible, false otherwise

loseFocus()
[inherits from WidgetBase]

Called before setFocus to notify previous focused widget

loseVMFocus(vmNewFocusedWidget : WidgetBase)
[inherits from WidgetBase]

Called before setting VM focus to notify previous VM focused widget

Parameters

vmNewFocusedWidget

new widget which get the focus

removeClass(className : string)
[inherits from WidgetBase]

Remove the given class from element

Parameters

className

class to delete

removeTextTransform()
[inherits from TextWidgetBase]

Remove both class which cause text-transform

replaceChildWidget(oldWidget : WidgetBase, newWidget : WidgetBase)
[inherits from WidgetGroupBase]

Remove a child widget to use another widget instead

Parameters

oldWidget	WidgetBase	the widget to replace
newWidget	WidgetBase	the widget to add

replaceWith(widget : WidgetBase)
[inherits from WidgetBase]

Replace the current widget with a given one

Parameters

widget

the new widget

resetWidth()

Reset width column (set with to initial width)

setAlwaysHidden(b : boolean)

Sets if the column must be always hidden

Parameters

b

is always hidden ?

setBackgroundColor(color : string, notImportant : boolean)
[inherits from ColoredWidgetBase]

Sets the background color

Parameters

color	string	a CSS color definition. Can be a color name ('red', 'blue'), an hex code ('#f5d48a') or a color function ('rgb(128, 255, 0)') null restores the default value.
notImportant	boolean	Set the CSS color definition on the ID whithout '!important'.

setColor(color : string)
[inherits from ColoredWidgetBase]

Set the fore color

Parameters

color

a CSS color definition. Can be a color name ('red', 'blue'), an hex code ('#f5d48a') or a color function ('rgb(128, 255, 0)'). null restores the default value.

setDefaultWidth(width : number)

Set the default column width from store settings

Parameters

width

column width (pixels)

setDialogType(dialogType : string)
[inherits from WidgetBase]

Set widget current dialog type. Can be Input, Input Array, Display, Display Array or Construct

Parameters

dialogType

Dialog type

setEnabled(enabled : boolean)
[inherits from WidgetBase]

Defines the enabled status of the widget

Parameters

enabled

true if the widget allows user interaction, false otherwise.

setFocus(fromMouse : boolean, stayOnSameWidget : boolean)
[inherits from WidgetBase]

Called when widget obtains the focus

Parameters

fromMouse	boolean	true if focus comes from mouse event
stayOnSameWidget	boolean	true if we want to set the focus to the current focused widget

setFocusable(focusable : boolean)
[inherits from WidgetBase]

Defines if the widget is focusable

Parameters

focusable

State of focusable

setFontColor() : (string)
[inherits from TextWidgetBase]

Set the font color used by this widget

Returns

(string) a CSS font color value

setFontFamily(fontFamily : string)
[inherits from TextWidgetBase]

Set the font-family used for this widget

Parameters

fontFamily

the font family to use. null restores the default value.

setFontSize(size : string)
[inherits from TextWidgetBase]

Set the font-size used for this widget

Parameters

size

a CSS font size value. null restores the default value.

setFontStyle(style : string)
[inherits from TextWidgetBase]

Set the font-style used for this widget

Parameters

style

a CSS font style value. null restores the default value.

setFontWeight(weight : string)
[inherits from TextWidgetBase]

Set the font weight used for this widget

Parameters

weight

a CSS font weight value. null restores the default value.

setInitialWidth(width : number)

Set measured column width as initial

Parameters

width

column width (pixels)

setMovable(b : boolean)

Sets if the column can be moved by the user

Parameters

b

is movable ?

setNoBorder(noBorder : boolean)
[inherits from WidgetBase]

Remove or add borders to the widget

Parameters

noBorder

true if the widget has no border class, false otherwise

setParentWidget(widget : WidgetGroupBase, options : Object)
[inherits from WidgetBase]

Defines the parent widget

Parameters

widget	WidgetGroupBase	the widget to use as parent
options	Object	possible options
options.noLayoutInvalidation	boolean	won't affect parent layout

setReverse(rtl : boolean)
[inherits from WidgetBase]

Set Arabic mode

Parameters

rtl

true if widget is right to left

setSizable(b : boolean)

Sets if the column can be sized by the user

Parameters

b

is sizable ?

setStyle(selector : string|Object, style : Object)
[inherits from WidgetBase]

Updates widget style with new rules

Parameters

selector	string\|Object	additional sub selector
style	Object	style properties to set

setTextDecoration()
[inherits from TextWidgetBase]

Set the text-decoration used for this widget

setTextTransform(transform : string)
[inherits from TextWidgetBase]

Set the text-transform used for this widget

Parameters

transform

a CSS text transform. null restores the default value.

setTitle(title : string)
[inherits from WidgetBase]

Set the title of the widget

Parameters

title

the tooltip text

setTitleText(text : string)

Sets column text (title)

Parameters

text

the text (title) to display

setWidth(width : number)

Sets the width of column

Parameters

width