Class TabControlHelper
- java.lang.Object
-
- com.microstrategy.web.app.utils.TabControlHelper
-
public class TabControlHelper extends java.lang.Object
This helper class takes care of displaying a tab control according to the information used for initializing it. The tab control is constructed as a form, therefore the information that needs to be included for its proper tab switching needs to be in the form of hidden inputs.
Each tab has a unique identifier, specified during the calls to the addTab() method. Use this same identifier to set the current selected tab by using the setSelectedTab() method.
Once the settings for the tab have been specified, the contents of the current selected tab have to be specified to the control by using the setContents() method.The different parameters that can be set when defining a new tab control include:
- Form Target - Indicates what the target of the form containing the tab control
- Border Padding - For specifying the width of the border to be left between the edge of the tab page and the contents to be displayed
- Use DHTML - Indicates whether the interface uses DHTML properties or not.
- Use Form - Indicates whether the interface should use form tags for processing the switch tab requests (default), or if should use regular links.
- Styles:
- Style Border Color - The css class that specifies the color of the border to be included on the tab control
- Style Selected Tab - indicates the css class to use for the tab marked as selected
- Style Unselected Tab - css class for the unselected tabs
- Style Selected Last Tab - css class for the selected tab if it happens to be the last one shown on the tab control. If ommited, the style for Selected Tab is used
- Style Unselected Tab - css class for the unselected tab located at the end of the tab control. If ommited, the style for Unselected Tab is used
- Style Selected Text - css class to apply to the text of the tab header marked as selected
- Style Unselected Text - css class to apply to the text of the unselected tab headers
- Images:
- Image Selected Tab - image to be displayed on the tab that is marked as selected, at the left of the text
- Image Unselected Tab - image to be displayed on the tabs not currently selected, at the left of the text
- Image Selected Cell Style - css style of the cell that will hold the image for the selected tab
- Image Unselected Cell Style - css style of the cell that will hold the images for the unselected tabs
Example
For the tab control shown on the object browser, the calls executed for initializing the tab control are as follows:TabControlHelper tab = new TabControlHelper();
target1 = eventSwitchToReportObjectsTab.getHiddenInputs();
target2 = eventSwitchToAllObjectsTab.getHiddenInputs();
formTarget = eventSwitchToReportObjectsTab.getSource().getRoot().getName();tab.addTab(String.valueOf(EnumObjectBrowserTabs.ObjectBrowserReportObjectsTab), getDescriptor(1951), target1); 'Descriptor: Report Objects
tab.addTab(String.valueOf(EnumObjectBrowserTabs.ObjectBrowserAllObjectsTab), getDescriptor(1952), target2); ' Descriptor: All Objects
tab.setSwitchTabsFormTarget(formTarget);
tab.setImageTab(imgArrowDown, imgArrowRight);
tab.setStyleTab("selectedTabCell", "unselectedTabCell");
tab.setStyleLastTab("selectedTabImage", "unselectedTabImage");
tab.setImageCellStyle("selectedTabImage", "unselectedTabImage");
tab.setBorderPadding(5);
tab.setBorderColor("borderStyle");
tab.setSelectedTab(String.valueOf(_currentTab));
tab.setUseDHTML(DHTML);
If the tab control to be displayed is to work on HTML mode only and no images are displayed together with the tabs so they can serve as INPUT images to submit the form, then the user can choose not to use forms but a direct link, for example:
TabControlHelper tab = new TabControlHelper();
target1 = eventSwitchToReportObjectsTab.getURLLink();
target2 = eventSwitchToAllObjectsTab.getURLLink();
tab.addTab(String.valueOf(EnumObjectBrowserTabs.ObjectBrowserReportObjectsTab), getDescriptor(1951), target1); 'Descriptor: Report Objects
tab.addTab(String.valueOf(EnumObjectBrowserTabs.ObjectBrowserAllObjectsTab), getDescriptor(1952), target2); ' Descriptor: All Objects
tab.setUseForm(false);
tab.setStyleTab("selectedTabCell", "unselectedTabCell");
tab.setStyleLastTab("selectedTabImage", "unselectedTabImage");
tab.setImageCellStyle("selectedTabImage", "unselectedTabImage");
tab.setBorderPadding(5);
tab.setBorderColor("borderStyle");
tab.setSelectedTab(String.valueOf(_currentTab));
tab.setUseDHTML(false); // Change its true default value
- Since:
- MicroStrategy Web 7.3.1 or earlier
- Form Target - Indicates what the target of the form containing the tab control
-
-
Field Summary
Fields Modifier and Type Field Description static int
TAB_ALIGNMENT_JUSTIFIED
Indicates the different tabs will be justified to the 100% of the width of the controlstatic int
TAB_ALIGNMENT_LEFT
Indicates the different tabs will be aligned to the left of the controlstatic int
TAB_ALIGNMENT_RIGHT
Indicates the different tabs will be aligned to the right of the control
-
Constructor Summary
Constructors Constructor Description TabControlHelper(AppContext appContext)
Class constructorTabControlHelper(ContainerServices containerServices)
Class constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
addTab(java.lang.String key, java.lang.String tabText, MarkupOutput contents)
Adds the requested tab to the collection.boolean
addTab(java.lang.String key, java.lang.String tabText, MarkupOutput contents, java.lang.String tabPrefix, java.lang.String tabSuffix)
Adds the requested tab to the collection.boolean
addTab(java.lang.String key, java.lang.String tabText, java.lang.String tabInfo)
Adds the requested tab to the collection.boolean
addTab(java.lang.String key, java.lang.String tabText, java.lang.String tabInfo, java.lang.String tabPrefix, java.lang.String tabSuffix)
Adds the requested tab to the collection.boolean
addTab(java.lang.String key, java.lang.String tabText, java.lang.String tabInfo, java.lang.String tabPrefix, java.lang.String tabSuffix, java.lang.String imgTooltip)
Adds the requested tab to the collection.void
clear()
Clear the tab definitionMarkupOutput
generateOutput()
Generates the HTML output for this tab instanceint
getBorderPadding()
Gets the border width to be applied to the tab controljava.lang.String
getExtraInput()
Gets any extra form input information that should be added to the events generated by this tab controljava.lang.String
getExtraUrl()
Gets any extra URL information that should be added to the events generated by this tab controljava.lang.String
getImageSelectedTab()
Gets the image to be displayed for the selected tabjava.lang.String
getImageUnselectedTab()
Gets the image to be displayed for the not selected tabsint
getIndexSelectedTab()
If no tab has been assigned as current, by default returns the first onejava.lang.String
getInfoSelectedTab()
Returns the information associated with the tab currently marked as selected.int
getSize()
Gets the number of tabs that have been added to the controljava.lang.String
getStyleBorderColor()
Gets the color of the border to be applied to the tab controljava.lang.String
getStyleSelectedImageCell()
Gets the style of the cell to hold the image to be used for the selected tabjava.lang.String
getStyleSelectedLastTab()
Gets the style to be used for the selected tab if it's the last one to be displayedjava.lang.String
getStyleSelectedTab()
Gets the style to be used for the selected tabjava.lang.String
getStyleSelectedText()
Gets the style to be used for the text of the selected tabjava.lang.String
getStyleUnselectedImageCell()
Gets the style of the cell to hold the image to be used for the not selected tabsjava.lang.String
getStyleUnselectedLastTab()
Gets the style to be used for the not selected tab if it's the last one to be displayedjava.lang.String
getStyleUnselectedTab()
Gets the style to be used for the not selected tabsjava.lang.String
getStyleUnselectedText()
Gets the style to be used for the text of the not selected tabsjava.lang.String
getSwitchTabsFormTarget()
Gets the target to be used when displaying the tabsint
getTabAlignment()
Gets the tab alignment to be used when displaying the tabs on the controljava.lang.String
getTextSelectedTab()
Returns what's the text being displayed for the tab that it's currently marked as selected.boolean
getUseApplyAllTabs()
Returns if this tab is to use the Apply All Tabs functionality or notboolean
getUseDHTML()
Returns whether the tab control displays DHTML or notboolean
getUseForm()
Returns if this tab is to generate a Form for switching tabs, or just regular linksboolean
getUseIFrame()
Returns whether this tab control will be using IFrame or notvoid
setBasePath(java.lang.String basePath)
Defines the base path where the image files used for regular formatting can be foundvoid
setBorderPadding(int value)
Sets the border padding to use when displaying the tab contentsvoid
setContents(MarkupOutput out)
Defines the contents of the current tab.void
setEventManager(EventManager newValue)
Assigns a newEventManager
instance to be used by the tab control for generating the events to be used for handling this instancevoid
setExtraInput(java.lang.String newValue)
Sets any extra form input information that should be added to the events generated by this tab controlvoid
setExtraUrl(java.lang.String newValue)
Sets any extra URL information that should be added to the events generated by this tab controlvoid
setImageCellStyle(java.lang.String selected, java.lang.String unSelected)
Defines the style of the cell that will hold the image to be used for the tabvoid
setImageSelectedTab(java.lang.String value)
Sets the image to display on the selected tabvoid
setImageTab(java.lang.String selected, java.lang.String unSelected)
Sets the image to be used when displaying the tabsvoid
setImageUnselectedTab(java.lang.String value)
Sets the image to display on the not selected tabsboolean
setSelectedTab(java.lang.String key)
Given the key sent as parameter, have the tab associated with this key selected as current one.void
setStyleBorderColor(java.lang.String value)
Sets the color of the border to use when displaying the tab contentsvoid
setStyleLastTab(java.lang.String selected, java.lang.String unSelected)
Defines the style of the last tab to be usedvoid
setStyleSelectedImageCell(java.lang.String value)
Sets the style to be used for the cell containing the image of the selected tabvoid
setStyleSelectedLastTab(java.lang.String value)
Sets the style to be used for the selected tab if it's the last one to be displayedvoid
setStyleSelectedTab(java.lang.String value)
Sets the style to be used for the selected tabvoid
setStyleSelectedText(java.lang.String value)
Sets the style to use for the text to be displayed for the selected tabvoid
setStyleTab(java.lang.String selected, java.lang.String unSelected)
Defines the style of the tabs to be displayed for this controlvoid
setStyleText(java.lang.String selected, java.lang.String unSelected)
Defines the style of the text to be used when displaying the tabsvoid
setStyleUnselectedImageCell(java.lang.String value)
Sets the style to be used for the cell containing the image of the not selected tabsvoid
setStyleUnselectedLastTab(java.lang.String value)
Sets the style to be used for the unselected tab if it's the last one to be displayedvoid
setStyleUnselectedTab(java.lang.String value)
Sets the style to be used for the unselected tabsvoid
setStyleUnselectedText(java.lang.String value)
Sets the style to use for the text to be displayed for the not selected tabsvoid
setSwitchTabsFormTarget(java.lang.String value)
Defines the target of the form that gets submitted when a switch tab is requestedvoid
setTabAlignment(int value)
Defines the alignment of the tabs to be displayed on the control.void
setUseApplyAllTabs(boolean useApplyAllTabs)
Defines if this tab is to use the Apply All Tabs functionality.void
setUseDHTML(boolean useDHTML)
Defines if this tab is to generate HTML or DHTML output.void
setUseForm(boolean useForm)
Defines if this tab is to generate a Form for switching tabs, or just regular links (by default it uses a form).void
setUseIFrame(boolean newValue)
Defines whether this tab control will be using an IFrame or not
-
-
-
Field Detail
-
TAB_ALIGNMENT_JUSTIFIED
public static final int TAB_ALIGNMENT_JUSTIFIED
Indicates the different tabs will be justified to the 100% of the width of the control- See Also:
- Constant Field Values
-
TAB_ALIGNMENT_LEFT
public static final int TAB_ALIGNMENT_LEFT
Indicates the different tabs will be aligned to the left of the control- See Also:
- Constant Field Values
-
TAB_ALIGNMENT_RIGHT
public static final int TAB_ALIGNMENT_RIGHT
Indicates the different tabs will be aligned to the right of the control- See Also:
- Constant Field Values
-
-
Constructor Detail
-
TabControlHelper
public TabControlHelper(ContainerServices containerServices)
Class constructor- Since:
- MicroStrategy Web 8.0.0
-
TabControlHelper
public TabControlHelper(AppContext appContext)
Class constructor- Since:
- MicroStrategy Web 9.0.1
-
-
Method Detail
-
setSelectedTab
public boolean setSelectedTab(java.lang.String key)
Given the key sent as parameter, have the tab associated with this key selected as current one. If no tab is associated with this key, returns false- Parameters:
key
-String
value that indicates the key of the selected tab- Returns:
True
if the key requested corresponds to an existing tab. ReturnsFalse
otherwise.
-
getIndexSelectedTab
public int getIndexSelectedTab()
If no tab has been assigned as current, by default returns the first one- Returns:
- the index of the selected tab
-
getTextSelectedTab
public java.lang.String getTextSelectedTab()
Returns what's the text being displayed for the tab that it's currently marked as selected.- Returns:
- the text shown for the selected tab
-
getInfoSelectedTab
public java.lang.String getInfoSelectedTab()
Returns the information associated with the tab currently marked as selected.- Returns:
- the information of the selected tab
-
addTab
public boolean addTab(java.lang.String key, java.lang.String tabText, java.lang.String tabInfo)
Adds the requested tab to the collection. If the key was already defined with another element, the previous value will be overwritten with the new information.- Parameters:
key
-String
value to associate as key of the tab being addedtabText
-String
to display when rendering the tabtabInfo
-String
containing the link to be used for accessing the contents of this tab- Returns:
- false if the key already existed on the collection.
-
addTab
public boolean addTab(java.lang.String key, java.lang.String tabText, java.lang.String tabInfo, java.lang.String tabPrefix, java.lang.String tabSuffix, java.lang.String imgTooltip)
Adds the requested tab to the collection. If the key was already defined with another element, the previous value will be overwritten with the new information.- Parameters:
key
-String
value to associate as key of the tab being addedtabText
-String
to display when rendering the tabtabInfo
-String
containing the link to be used for accessing the contents of this tabtabPrefix
-String
to display before the text of the tab. It will not be part of the link generated for switching tabs (if not using forms), but will have the same CSS Style as the text.tabSuffix
-String
to display after the text of the tab. It will not be part of the link generated for switching tabs (if not using forms), but will have the same CSS Style as the text.imgTooltip
-String
to be used as tooltip if there's an image to render together with this tab when it's not selected- Returns:
- false if the key already existed on the collection.
-
addTab
public boolean addTab(java.lang.String key, java.lang.String tabText, java.lang.String tabInfo, java.lang.String tabPrefix, java.lang.String tabSuffix)
Adds the requested tab to the collection. If the key was already defined with another element, the previous value will be overwritten with the new information.- Parameters:
key
-String
value to associate as key of the tab being addedtabText
-String
to display when rendering the tabtabInfo
-String
containing the link to be used for accessing the contents of this tabtabPrefix
-String
to display before the text of the tab. It will not be part of the link generated for switching tabs (if not using forms), but will have the same CSS Style as the text.tabSuffix
-String
to display after the text of the tab. It will not be part of the link generated for switching tabs (if not using forms), but will have the same CSS Style as the text.- Returns:
- false if the key already existed on the collection.
-
addTab
public boolean addTab(java.lang.String key, java.lang.String tabText, MarkupOutput contents)
Adds the requested tab to the collection. If the key was already defined with another- Parameters:
key
-String
value to associate as key of the tab being addedtabText
-String
to display when rendering the tabcontents
- aMarkupOutput
instance initialized with the contents of this tab. If contents are going to be defined for each tab, they should be inside atag identified with the same name as the key specified for this tab in order to have it enabled to be hidden or shown as requested by the final user. Somewhere in the contents the required hidden inputs should be included so the event gets handled correctly.- Returns:
- false if the key already existed on the collection.
-
addTab
public boolean addTab(java.lang.String key, java.lang.String tabText, MarkupOutput contents, java.lang.String tabPrefix, java.lang.String tabSuffix)
Adds the requested tab to the collection. If the key was already defined with another element, the previous value will be overwritten with the new information.- Parameters:
key
-String
value to associate as key of the tab being addedtabText
-String
to display when rendering the tabcontents
- aMarkupOutput
instance initialized with the contents of this tab. If contents are going to be defined for each tab, they should be inside atag identified with the same name as the key specified for this tab in order to have it enabled to be hidden or shown as requested by the final user. Somewhere in the contents the required hidden inputs should be included so the event gets handled correctly.tabPrefix
-String
to display before the text of the tab. It will not be part of the link generated for switching tabs (if not using forms), but will have the same CSS Style as the text.tabSuffix
-String
to display after the text of the tab. It will not be part of the link generated for switching tabs (if not using forms), but will have the same CSS Style as the text.- Returns:
- false if the key already existed on the collection.
-
clear
public void clear()
Clear the tab definition
-
generateOutput
public MarkupOutput generateOutput()
Generates the HTML output for this tab instance- Returns:
- a
MarkupOutput
instance with the HTML to be rendered for this tab control.
-
setStyleLastTab
public void setStyleLastTab(java.lang.String selected, java.lang.String unSelected)
Defines the style of the last tab to be used- Parameters:
selected
- the css style to use if the last tab is a selected oneunSelected
- the css style to use if the last tab is not the selected one
-
setStyleTab
public void setStyleTab(java.lang.String selected, java.lang.String unSelected)
Defines the style of the tabs to be displayed for this control- Parameters:
selected
- css style to use for the selected tabunSelected
- css style to use for the not selected tabs
-
setImageCellStyle
public void setImageCellStyle(java.lang.String selected, java.lang.String unSelected)
Defines the style of the cell that will hold the image to be used for the tab- Parameters:
selected
- css style to use for the cell that holds the image for a selected tabunSelected
- css style to use for the cell that holds the image for the not selected tabs
-
setStyleText
public void setStyleText(java.lang.String selected, java.lang.String unSelected)
Defines the style of the text to be used when displaying the tabs- Parameters:
selected
- css style to use for the text of the selected tabunSelected
- css style to use for the text of the not selected tabs.
-
setImageTab
public void setImageTab(java.lang.String selected, java.lang.String unSelected)
Sets the image to be used when displaying the tabs- Parameters:
selected
- image source to be used for the selected tabunSelected
- image source to be used for the not selected tabs.
-
setUseDHTML
public void setUseDHTML(boolean useDHTML)
Defines if this tab is to generate HTML or DHTML output. It disables the Apply All Tabs functionality if set toFalse
.- Parameters:
useDHTML
- boolean indicating if DHTML should be generated or not
-
setUseApplyAllTabs
public void setUseApplyAllTabs(boolean useApplyAllTabs)
Defines if this tab is to use the Apply All Tabs functionality. If set toTrue
, it disables the use of a Form for switching tabs and it enables the use of DHTML.- Parameters:
useApplyAllTabs
- boolean indicating if the Apply All Tabs approach should be generated or not
-
setUseForm
public void setUseForm(boolean useForm)
Defines if this tab is to generate a Form for switching tabs, or just regular links (by default it uses a form). It disables the Apply All Tabs functionality if set toTrue
.- Parameters:
useForm
- boolean indicating if a Form should be generated or not
-
setSwitchTabsFormTarget
public void setSwitchTabsFormTarget(java.lang.String value)
Defines the target of the form that gets submitted when a switch tab is requested- Parameters:
value
- the target where to go when switching tabs has been asked for
-
setStyleSelectedLastTab
public void setStyleSelectedLastTab(java.lang.String value)
Sets the style to be used for the selected tab if it's the last one to be displayed- Parameters:
value
- css style to use
-
setStyleUnselectedLastTab
public void setStyleUnselectedLastTab(java.lang.String value)
Sets the style to be used for the unselected tab if it's the last one to be displayed- Parameters:
value
- css style to use
-
setContents
public void setContents(MarkupOutput out)
Defines the contents of the current tab.- Parameters:
out
- aMarkupOutput
instance initialized with the HTML to be displayed as the current tab contents. These contents will be ignored if when adding tabs to the helper at least one content was defined.
-
setStyleSelectedTab
public void setStyleSelectedTab(java.lang.String value)
Sets the style to be used for the selected tab- Parameters:
value
- css style to use
-
setStyleUnselectedTab
public void setStyleUnselectedTab(java.lang.String value)
Sets the style to be used for the unselected tabs- Parameters:
value
- css style to use
-
setStyleSelectedImageCell
public void setStyleSelectedImageCell(java.lang.String value)
Sets the style to be used for the cell containing the image of the selected tab- Parameters:
value
- css style to use
-
setStyleUnselectedImageCell
public void setStyleUnselectedImageCell(java.lang.String value)
Sets the style to be used for the cell containing the image of the not selected tabs- Parameters:
value
- css style to use
-
setStyleSelectedText
public void setStyleSelectedText(java.lang.String value)
Sets the style to use for the text to be displayed for the selected tab- Parameters:
value
- css style to use
-
setStyleUnselectedText
public void setStyleUnselectedText(java.lang.String value)
Sets the style to use for the text to be displayed for the not selected tabs- Parameters:
value
- css style to use
-
setImageSelectedTab
public void setImageSelectedTab(java.lang.String value)
Sets the image to display on the selected tab- Parameters:
value
- image source to be used
-
setImageUnselectedTab
public void setImageUnselectedTab(java.lang.String value)
Sets the image to display on the not selected tabs- Parameters:
value
- image source to be used
-
setBorderPadding
public void setBorderPadding(int value)
Sets the border padding to use when displaying the tab contents- Parameters:
value
- an integer value with the width to be left between the edge of the tab control and its contents
-
setStyleBorderColor
public void setStyleBorderColor(java.lang.String value)
Sets the color of the border to use when displaying the tab contents- Parameters:
value
- hexadecimal color code to apply when displaying the border of the tab control
-
setTabAlignment
public void setTabAlignment(int value)
Defines the alignment of the tabs to be displayed on the control. Possible values include the TAB_ALIGNMENT_LEFT, TAB_ALIGNMENT_RIGHT and TAB_ALIGNMENT_JUSTIFIED constants defined on this class.- Parameters:
value
- the alignment to use when displaying the tab control
-
setBasePath
public void setBasePath(java.lang.String basePath)
Defines the base path where the image files used for regular formatting can be found- Parameters:
basePath
- String with the base path to access for finding the required files (for example, "..")
-
getUseDHTML
public boolean getUseDHTML()
Returns whether the tab control displays DHTML or not- Returns:
- a boolean value indicating if the tab uses DHTML or not
-
getUseForm
public boolean getUseForm()
Returns if this tab is to generate a Form for switching tabs, or just regular links- Returns:
- a boolean value indicating if the tab uses a Form or not
-
getUseApplyAllTabs
public boolean getUseApplyAllTabs()
Returns if this tab is to use the Apply All Tabs functionality or not- Returns:
- a boolean value indicating if the Apply All Tabs approach is to be used for this tab control or not
-
getSwitchTabsFormTarget
public java.lang.String getSwitchTabsFormTarget()
Gets the target to be used when displaying the tabs- Returns:
- the target to go to once a switch tab request has been submitted
-
getStyleSelectedLastTab
public java.lang.String getStyleSelectedLastTab()
Gets the style to be used for the selected tab if it's the last one to be displayed- Returns:
- css style used
-
getStyleUnselectedLastTab
public java.lang.String getStyleUnselectedLastTab()
Gets the style to be used for the not selected tab if it's the last one to be displayed- Returns:
- css style used
-
getStyleSelectedTab
public java.lang.String getStyleSelectedTab()
Gets the style to be used for the selected tab- Returns:
- css style used
-
getStyleUnselectedTab
public java.lang.String getStyleUnselectedTab()
Gets the style to be used for the not selected tabs- Returns:
- css style used
-
getStyleSelectedText
public java.lang.String getStyleSelectedText()
Gets the style to be used for the text of the selected tab- Returns:
- css style used
-
getStyleUnselectedText
public java.lang.String getStyleUnselectedText()
Gets the style to be used for the text of the not selected tabs- Returns:
- css stylel used
-
getImageSelectedTab
public java.lang.String getImageSelectedTab()
Gets the image to be displayed for the selected tab- Returns:
- source of the image to be used
-
setExtraUrl
public void setExtraUrl(java.lang.String newValue)
Sets any extra URL information that should be added to the events generated by this tab control- Parameters:
newValue
-String
with any extra URL to add to the links to be displayed by this tab control
-
getExtraUrl
public java.lang.String getExtraUrl()
Gets any extra URL information that should be added to the events generated by this tab control- Returns:
String
with any extra URL to add to the links to be displayed by this tab control
-
setExtraInput
public void setExtraInput(java.lang.String newValue)
Sets any extra form input information that should be added to the events generated by this tab control- Parameters:
newValue
-String
with any extra input information to add to the forms to be displayed by this tab control
-
getExtraInput
public java.lang.String getExtraInput()
Gets any extra form input information that should be added to the events generated by this tab control- Returns:
String
with any extra input information to add to the forms to be displayed by this tab control
-
getImageUnselectedTab
public java.lang.String getImageUnselectedTab()
Gets the image to be displayed for the not selected tabs- Returns:
- source of the image to be used
-
getStyleSelectedImageCell
public java.lang.String getStyleSelectedImageCell()
Gets the style of the cell to hold the image to be used for the selected tab- Returns:
- css style to use
-
getStyleUnselectedImageCell
public java.lang.String getStyleUnselectedImageCell()
Gets the style of the cell to hold the image to be used for the not selected tabs- Returns:
- css style to use
-
getBorderPadding
public int getBorderPadding()
Gets the border width to be applied to the tab control- Returns:
- width of the border to be used
-
getSize
public int getSize()
Gets the number of tabs that have been added to the control- Returns:
- the number of tabs available. If none yet, returns zero.
-
getStyleBorderColor
public java.lang.String getStyleBorderColor()
Gets the color of the border to be applied to the tab control- Returns:
- color to be used for the tab border
-
getTabAlignment
public int getTabAlignment()
Gets the tab alignment to be used when displaying the tabs on the control- Returns:
- the TAB_ALIGNMENT_LEFT, TAB_ALIGNMENT_RIGHT or TAB_ALIGNMENT_JUSTIFIED constants depending on the setting defined
-
setUseIFrame
public void setUseIFrame(boolean newValue)
Defines whether this tab control will be using an IFrame or not- Parameters:
newValue
-boolean
value indicating if this interface will be interacting with an IFrame control
-
getUseIFrame
public boolean getUseIFrame()
Returns whether this tab control will be using IFrame or not- Returns:
boolean
value indicating if this interface will be interacting with an IFrame control
-
setEventManager
public void setEventManager(EventManager newValue)
Assigns a newEventManager
instance to be used by the tab control for generating the events to be used for handling this instance- Parameters:
newValue
- aEventManager
instance, initialized
-
-