|
|
|||||
| Package com.dassault_systemes.catjdialog |
Class CATTabPage
|
| Class Hierarchy |
java.lang.Object
|
+-com.dassault_systemes.catjdialog.CATCallbackSource
|
+-com.dassault_systemes.catjdialog.CATDialog
|
+-com.dassault_systemes.catjdialog.CATTabPage
| Class Location |
| Class Description |
public class CATTabPage
The tab-page graphical component.
To add a tab:
addTab().
To remove a tab:
removeTab(),
The application can be notified when the selected tab changes.
<tabcomponent_path>.Title entries.
You may also set them programmatically using setTabTitle().
| Field Summary |
| Constructor Summary |
| CATTabPage(CATDialog iDialog, String iName)
Creates a tab page with the specified parent and name. |
| Method Summary |
| public void | addTab(String iName)
Adds a Tab page. |
| public void | addTabAt(String iName, int index)
Adds a Tab page at specified index. |
| protected boolean | displayChild(CATDialog iChild)
Tries to display the given child component. |
| public String | getSelection()
Returns the selected tab name. |
| public CATNotification | getTabActivatedNotification()
Returns the tab activated notification. |
| public String | getTabAt(int index)
Returns the tab name at specified index. |
| public int | getTabCount()
Returns the number of tabs. |
| public Enumeration | getTabs()
Returns the ordered list of tab names (String enumeration). |
| public String | getTabTitle(String iName)
Returns the tab title. |
| public boolean | getTabVisibility()
Determines whether tabs selector is displayed. |
| protected boolean | isChildDisplayed(CATDialog iChild)
Determines whether the child component is displayed by this component. |
| public void | removeAndDestroyTab(String iName)
Removes a Tab page and destroys the associated component. |
| public void | removeAndDestroyTabAt(int index)
Removes a Tab page at specified index and destroys the associated component. |
| public void | removeTab(String iName)
Removes a Tab page. |
| public void | removeTabAt(int index)
Removes a Tab page at specified index Note: the related dialog isn't destroyed after this call. |
| public void | setSelection(String iName)
Sets the selected tab name. |
| public void | setTabs(Enumeration iNames)
Sets the ordered list of tab names (String enumeration). |
| public void | setTabTitle(String iName, String iTitle)
Sets the tab title. |
| public void | setTabVisibility(boolean iTabVisibility)
Shows/hides the tabs selector. |
| Field Detail |
| Constructor Detail |
CATTabPage(CATDialog iDialog, String iName)
Creates a tab page with the specified parent and name.
iParentiName| Method Detail |
public void addTab(String iName)
Adds a Tab page.
The new tab is appended to the list of tabs.
Note: the name must correspond to an existing child component name, that is not yet registered as a tab.
iName
public void addTabAt(String iName, int index)
Adds a Tab page at specified index.
The new tab is inserted into the list of tabs at given index.
Note: the name must correspond to an existing child component name, that is not yet registered as a tab.
iNameindex
protected boolean displayChild(CATDialog iChild)
Tries to display the given child component.
iChild
public String getSelection()
Returns the selected tab name.
public CATNotification getTabActivatedNotification()
Returns the tab activated notification.
This notification is sent when the selected tab page changes.
public String getTabAt(int index)
Returns the tab name at specified index.
index
public int getTabCount()
Returns the number of tabs.
public Enumeration getTabs()
Returns the ordered list of tab names (String enumeration).
Tab names correspond to children components names.
public String getTabTitle(String iName)
Returns the tab title.
Returns the programmatic value if setTabTitle() has been called,
or tries to retrieve its label from the associated message catalog file
(<tabcomponent_path>.Title entry).
iName
public boolean getTabVisibility()
Determines whether tabs selector is displayed.
true if the tabs selector is displayed; false if it is hidden.
protected boolean isChildDisplayed(CATDialog iChild)
Determines whether the child component is displayed by this component.
iChildtrue if the specified child component is displayed by this component; false otherwise.
public void removeAndDestroyTab(String iName)
Removes a Tab page and destroys the associated component.
iName
public void removeAndDestroyTabAt(int index)
Removes a Tab page at specified index and destroys the associated component.
index
public void removeTab(String iName)
Removes a Tab page.
Note: the name should correspond to an existing child component name, that is registered as a tab.
Note: the related dialog isn't destroyed after this call.
The application should do it if required (use tabpage.getChild(iName).requestDestruction()).
iName
public void removeTabAt(int index)
Removes a Tab page at specified index
Note: the related dialog isn't destroyed after this call.
The application should do it if required (use tabpage.getChild(iName).requestDestruction()).
index
public void setSelection(String iName)
Sets the selected tab name.
iName
public void setTabs(Enumeration iNames)
Sets the ordered list of tab names (String enumeration).
Note: Tab names must correspond to existing children components names.
iNames
public void setTabTitle(String iName, String iTitle)
Sets the tab title.
Calling this method sets programmatically the title. This should
be reserved for cases where the title can only be determined by dynamic
means.
The standard way of defining components messages is using CATNls catalog
files (supports NLS).
iNameiTitle
public void setTabVisibility(boolean iTabVisibility)
Shows/hides the tabs selector.
When hidden, the user does not see the tabs anymore. He has no way of changing tab, only the current selected tab page is displayed.
iTabVisibilitytrue to show the tabs selector; false to hide it.