:: com :: sun :: star :: ui ::

interface XDeck

Methods' Summary
getId The deck identifier  
getTitle Get the deck title string  
setTitle Set the deck title string  
isActive Is the deck the active one  
activate Activate the deck and display its content  
getOrderIndex Get the ordering index of the deck button in sidebar  
setOrderIndex Set the ordering index of the deck button in sidebar  
moveFirst Move deck button at first position in sidebar  
moveLast Move deck button at last position in sidebar  
moveUp Move deck one step up in the sidebar  
moveDown Move deck one step down in the sidebar  
getPanels Panels collection attached to the deck  
Methods' Details
getId
string
getId();

Description
The deck identifier
getTitle
string
getTitle();

Description
Get the deck title string
setTitle
void
setTitle( [in] string  newTitle );

Description
Set the deck title string
Parameter newTitle
The new title string
isActive
boolean
isActive();

Description
Is the deck the active one
activate
void
activate( [in] boolean  bActivate );

Description
Activate the deck and display its content
Parameter bActivate
The requested state for the deck
  • TRUE sets the deck as the active one
  • FALSE hide the deck and defaults to the first deck of the sidebar
getOrderIndex
long
getOrderIndex();

Description
Get the ordering index of the deck button in sidebar
setOrderIndex
void
setOrderIndex( [in] long  newOrderIndex );

Description
Set the ordering index of the deck button in sidebar
Parameter newOrderIndex
The new position
moveFirst
void
moveFirst();

Description
Move deck button at first position in sidebar
moveLast
void
moveLast();

Description
Move deck button at last position in sidebar
moveUp
void
moveUp();

Description
Move deck one step up in the sidebar
moveDown
void
moveDown();

Description
Move deck one step down in the sidebar
getPanels
XPanels
getPanels();

Description
Panels collection attached to the deck
Top of Page