Accessors for class IlvNotebook

Properties

bottomPageMargin
count
firstVisible
flipLabels
leftPageMargin
pageArea
parent
rightPageMargin
selectedPage
tabXMargin
tabYMargin
tabsPosition
topPageMargin
verticalLabels

Methods

ensureVisible
getPage
getPageByName

Description

IlvNotebook is a predefined gadget class that simulates a real notebook. It allows the user to select the pages of the notebook by using the pointing device.
You can customize the notebook to meet your specific application requirements:

Tabs can be displayed on any side of the notebook.
Tabs can contain a simple label or a bitmap (or both).
Tab labels can be displayed vertically or horizontally.

Each page of the notebook is implemented by the class IlvNotebookPage. The default implementation of this class is to create an IlvGadgetContainer that displays the contents of the page.

Type Name Description Notes

UInt bottomPageMargin Returns the margins between the notebook borders and the page area of the notebook page (see pageArea).

UInt count Returns the number of notebook pages.

Void ensureVisible(UInt index) Ensures that the tab with the index index becomes visible. This does not change the selected tab.

UInt firstVisible Changes the first visible tab. This only scrolls the tabs and does not change the selected page.
Returns the index (starting at 0) of the first visible tab. If this value is not 0,some tabs are not visible and the scrolling arrows are visible.

Boolean flipLabels Changes the display style of the tab labels.

Object getPage(UInt index) Returns the notebook page whose index is supplied as a parameter.

Object getPageByName(String name) Returns the notebook page whose name is specified as a parameter.

UInt leftPageMargin Returns the margins between the notebook borders and the page area of the notebook page (see pageArea).

IlvRect pageArea Returns the rectangle of the page area with the page margin having already been taken into account.

IlvGadgetContainer parent Returns the view, if any, where the notebook is displayed.

UInt rightPageMargin Returns the margins between the notebook borders and the page area of the notebook page (see pageArea).

UInt selectedPage Sets or gets the index of the selected page.

UInt tabXMargin Changes the x margin of the notebook. This margin is the horizontal space between the border of the tab and the tab label. It becomes a vertical space when labels are drawn vertically.
Returns the x margin of the notebook.

UInt tabYMargin Changes the y margin of the notebook.
Returns the y margin of the notebook. This margin is the vertical space between the border of the tab and the tab label. It becomes a horizontal space when labels are drawn horizontally.

Direction tabsPosition Sets or gets the position of the tabs. Tabs can be displayed on any side of the notebook (IlvTop, IlvRight, IlvLeft, IlvBottom).

UInt topPageMargin Returns the margins between the notebook borders and the page area of the notebook page (see pageArea).

Boolean verticalLabels Changes the orientation of the labels. Each tab of the notebook can contain a label, which can be drawn horizontally or vertically.
Returns true if the tab labels are drawn vertically.

Type	Name	Description
`UInt`	`bottomPageMargin`	Returns the margins between the notebook borders and the page area of the notebook page (see `pageArea`).
`UInt`	`count`	Returns the number of notebook pages.
`Void`	`ensureVisible(UInt index)`	Ensures that the tab with the index `index` becomes visible. This does not change the selected tab.
`UInt`	`firstVisible`	Changes the first visible tab. This only scrolls the tabs and does not change the selected page. Returns the index (starting at `0`) of the first visible tab. If this value is not `0,`some tabs are not visible and the scrolling arrows are visible.
`Boolean`	`flipLabels`	Changes the display style of the tab labels.
`Object`	`getPage(UInt index)`	Returns the notebook page whose index is supplied as a parameter.
`Object`	`getPageByName(String name)`	Returns the notebook page whose name is specified as a parameter.
`UInt`	`leftPageMargin`	Returns the margins between the notebook borders and the page area of the notebook page (see `pageArea`).
`IlvRect`	`pageArea`	Returns the rectangle of the page area with the page margin having already been taken into account.
`IlvGadgetContainer`	`parent`	Returns the view, if any, where the notebook is displayed.
`UInt`	`rightPageMargin`	Returns the margins between the notebook borders and the page area of the notebook page (see `pageArea`).
`UInt`	`selectedPage`	Sets or gets the index of the selected page.
`UInt`	`tabXMargin`	Changes the x margin of the notebook. This margin is the horizontal space between the border of the tab and the tab label. It becomes a vertical space when labels are drawn vertically. Returns the x margin of the notebook.
`UInt`	`tabYMargin`	Changes the y margin of the notebook`.` Returns the y margin of the notebook. This margin is the vertical space between the border of the tab and the tab label. It becomes a horizontal space when labels are drawn horizontally.
`Direction`	`tabsPosition`	Sets or gets the position of the tabs. Tabs can be displayed on any side of the notebook (`IlvTop`, `IlvRight`, `IlvLeft`, `IlvBottom`).
`UInt`	`topPageMargin`	Returns the margins between the notebook borders and the page area of the notebook page (see `pageArea`).
`Boolean`	`verticalLabels`	Changes the orientation of the labels. Each tab of the notebook can contain a label, which can be drawn horizontally or vertically. Returns `true` if the tab labels are drawn vertically.