ScrollBar

PowerBuilder. ScrollBar

new ScrollBar(props[opt]) → {ScrollBar}

The description of a ScrollBar test object.
Parameters:
NameTypeAttributesDescription
propsObject <optional>
Initializes a ScrollBar test object using the supplied property bag.
Returns:
the description object that was initialized.
Type
ScrollBar

Methods

absoluteLocation(location[opt]) → {Point|Description}

The object's coordinates relative to the screen in pixels. 0,0 is the top-left corner of the primary monitor.
Parameters:
NameTypeAttributesDescription
locationPoint <optional>
When provided, this method acts as a setter and sets the absoluteLocation value.
Returns:
If no parameter is provided, the method acts as a getter and returns the absoluteLocation value; otherwise it returns 'this' for use with the builder pattern.
Type
Point | Description

isEnabled(isEnabled[opt]) → {boolean|Description}

Indicates whether the object is enable.
Parameters:
NameTypeAttributesDescription
isEnabledboolean <optional>
When provided, this method acts as a setter and sets the isEnabled value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isEnabled value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

isFocused(isFocused[opt]) → {boolean|Description}

Indicates whether the object is focused.
Parameters:
NameTypeAttributesDescription
isFocusedboolean <optional>
When provided, this method acts as a setter and sets the isFocused value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isFocused value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

isVisible(isVisible[opt]) → {boolean|Description}

Indicates whether the object is visible.
Parameters:
NameTypeAttributesDescription
isVisibleboolean <optional>
When provided, this method acts as a setter and sets the isVisible value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isVisible value; otherwise it returns 'this' for use with the builder pattern.
Type
boolean | Description

location(location[opt]) → {Point|Description}

The object's coordinates relative to the parent's location in pixels.
Parameters:
NameTypeAttributesDescription
locationPoint <optional>
When provided, this method acts as a setter and sets the location value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored location value; otherwise it returns 'this' for use with the builder pattern.
Type
Point | Description

maxPosition(maxPosition[opt]) → {number|Description}

The maximum position of the scroll bar.
Parameters:
NameTypeAttributesDescription
maxPositionnumber <optional>
When provided, this method acts as a setter and sets the maxPosition value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored maxPosition value; otherwise it returns 'this' for use with the builder pattern.
Type
number | Description

minPosition(minPosition[opt]) → {number|Description}

The minimum position of the scroll bar.
Parameters:
NameTypeAttributesDescription
minPositionnumber <optional>
When provided, this method acts as a setter and sets the minPosition value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored minPosition value; otherwise it returns 'this' for use with the builder pattern.
Type
number | Description

objectName(objectName[opt]) → {string|Description}

The object's name as set by the developer.
Parameters:
NameTypeAttributesDescription
objectNamestring <optional>
When provided, this method acts as a setter and sets the objectName value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored objectName value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

position(position[opt]) → {number|Description}

The position of the scroll bar.
Parameters:
NameTypeAttributesDescription
positionnumber <optional>
When provided, this method acts as a setter and sets the position value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored position value; otherwise it returns 'this' for use with the builder pattern.
Type
number | Description

size(size[opt]) → {Size|Description}

The object's size in pixels.
Parameters:
NameTypeAttributesDescription
sizeSize <optional>
When provided, this method acts as a setter and sets the size value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored size value; otherwise it returns 'this' for use with the builder pattern.
Type
Size | Description

text(text[opt]) → {string|Description}

The text associated with the object.
Parameters:
NameTypeAttributesDescription
textstring <optional>
When provided, this method acts as a setter and sets the text value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored text value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

windowTitleRegExp(windowClassRegExp[opt]) → {string|Description}

The constant part of the window title.
Parameters:
NameTypeAttributesDescription
windowClassRegExpstring <optional>
When provided, this method acts as a setter and sets the windowTitleRegExp value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored windowTitleRegExp value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description