SCROLLBAR

Overview

The SCROLLBAR class implements ISMScrollbar and IPrefixedConstantsObject to provide constants related to scrollbars in a solution model. It includes a getPrefix method that returns the prefix "SM_SCROLLBAR" for identifying related constants and overrides the toString method to provide a descriptive name.

Constants Summarized

Type	Name	Summary
Number	HORIZONTAL_SCROLLBAR_ALWAYS	Used to set the horizontal scroll bar policy so that horizontal scrollbars are always displayed.
Number	HORIZONTAL_SCROLLBAR_AS_NEEDED	Used to set the horizontal scroll bar policy so that horizontal scrollbars are displayed only when needed.
Number	HORIZONTAL_SCROLLBAR_NEVER	Used to set the horizontal scroll bar policy so that horizontal scrollbars are never displayed.
Number	SCROLLBARS_WHEN_NEEDED	Used to set the horizontal and vertical scroll bar policy so that both scrollbars are displayed only when needed.
Number	VERTICAL_SCROLLBAR_ALWAYS	Used to set the vertical scroll bar policy so that vertical scrollbars are always displayed.
Number	VERTICAL_SCROLLBAR_AS_NEEDED	Used to set the vertical scroll bar policy so that vertical scrollbars are displayed only when needed.
Number	VERTICAL_SCROLLBAR_NEVER	Used to set the vertical scroll bar policy so that vertical scrollbars are never displayed.

Constants Detailed

HORIZONTAL_SCROLLBAR_ALWAYS

Used to set the horizontal scroll bar policy so that horizontal scrollbars are always displayed.

Type Number

Sample

var alwaysScrollbars = form.newField('my_table_text', JSField.TEXT_AREA, 230, 10, 100, 100);
alwaysScrollbars.scrollbars = SM_SCROLLBAR.HORIZONTAL_SCROLLBAR_ALWAYS | SM_SCROLLBAR.VERTICAL_SCROLLBAR_ALWAYS;

HORIZONTAL_SCROLLBAR_AS_NEEDED

Used to set the horizontal scroll bar policy so that horizontal scrollbars are displayed only when needed.

Type Number

Sample

var neededScrollbars = form.newField('my_table_text', JSField.TEXT_AREA, 120, 10, 100, 100);
neededScrollbars.scrollbars = SM_SCROLLBAR.HORIZONTAL_SCROLLBAR_AS_NEEDED | SM_SCROLLBAR.VERTICAL_SCROLLBAR_AS_NEEDED;

HORIZONTAL_SCROLLBAR_NEVER

Used to set the horizontal scroll bar policy so that horizontal scrollbars are never displayed.

Type Number

Sample

var noScrollbars = form.newField('my_table_text', JSField.TEXT_AREA, 10, 10, 100, 100);
noScrollbars.scrollbars = SM_SCROLLBAR.HORIZONTAL_SCROLLBAR_NEVER | SM_SCROLLBAR.VERTICAL_SCROLLBAR_NEVER;

SCROLLBARS_WHEN_NEEDED

Used to set the horizontal and vertical scroll bar policy so that both scrollbars are displayed only when needed.

Type Number

Sample

var neededScrollbars = form.newField('my_table_text', JSField.TEXT_AREA, 120, 10, 100, 100);
// This is the default option, but if you really want you can set it explicitly.
neededScrollbars.scrollbars = SM_SCROLLBAR.SCROLLBARS_WHEN_NEEDED;

VERTICAL_SCROLLBAR_ALWAYS

Used to set the vertical scroll bar policy so that vertical scrollbars are always displayed.

Type Number

Sample

var alwaysScrollbars = form.newField('my_table_text', JSField.TEXT_AREA, 230, 10, 100, 100);
alwaysScrollbars.scrollbars = SM_SCROLLBAR.HORIZONTAL_SCROLLBAR_ALWAYS | SM_SCROLLBAR.VERTICAL_SCROLLBAR_ALWAYS;

VERTICAL_SCROLLBAR_AS_NEEDED

Used to set the vertical scroll bar policy so that vertical scrollbars are displayed only when needed.

Type Number

Sample

var neededScrollbars = form.newField('my_table_text', JSField.TEXT_AREA, 120, 10, 100, 100);
neededScrollbars.scrollbars = SM_SCROLLBAR.HORIZONTAL_SCROLLBAR_AS_NEEDED | SM_SCROLLBAR.VERTICAL_SCROLLBAR_AS_NEEDED;

VERTICAL_SCROLLBAR_NEVER

Used to set the vertical scroll bar policy so that vertical scrollbars are never displayed.

Type Number

Sample

var noScrollbars = form.newField('my_table_text', JSField.TEXT_AREA, 10, 10, 100, 100);
noScrollbars.scrollbars = SM_SCROLLBAR.HORIZONTAL_SCROLLBAR_NEVER | SM_SCROLLBAR.VERTICAL_SCROLLBAR_NEVER;

---