TabbedContainer (TotalCrossSDK 6.1.0 API)

java.lang.Object
- totalcross.ui.gfx.GfxSurface
- - totalcross.ui.Control
  - - totalcross.ui.Container
    - - totalcross.ui.ClippedContainer
      - totalcross.ui.TabbedContainer

All Implemented Interfaces:: ControlAnimation.AnimationFinished, Scrollable

public class TabbedContainer
extends ClippedContainer
implements Scrollable, ControlAnimation.AnimationFinished

TabbedContainer is a bar of text or image tabs. It is assumed that all images will have the same height, but they may have different widths.
A scroll is automatically added when the total width of the titles is bigger than the control's width.
The containers are created automatically and switched when the user press the corresponding tab.

Here is an example showing a tab bar being used:

 public class MyProgram extends MainWindow
 {
    TabbedContainer tab;

    public void initUI()
    {
       String names[] = {"Edition","Report"};
       tab = new TabbedContainer(names);
       add(tab);
       tab.setGaps(2,2,2,2); // set it before setting the rect
       tab.setRect(LEFT,TOP,FILL,FILL);
       tab.setContainer(0,new Edition()); // replace container 1 by a class that extends Container.
       tab.getContainer(1).add(new Label("Not implemented"),CENTER,CENTER);
    }

    public void onEvent(Event event)
    {
       if (event.type == ControlEvent.PRESSED && event.target == tp)
       {
          int activeIndex = tp.getActiveTab();
          ... handle tab being pressed
       }
    }
 }

Here's another sample that will show two TabbedContainers, one with images and another one with scrolling tabs. Note that you must create img1.png and img2.png.

 TabbedContainer tp1 = new TabbedContainer(new Image[]{new Image("img1.png"), new Image("img2.png")}, null);
 add(tp1);
 tp1.setRect(LEFT,TOP,Settings.screenWidth/2,Settings.screenHeight/2);
 tp1.activeTabBackColor = Color.getRGB(222,222,222);

 TabbedContainer tp2 = new TabbedContainer(new String[]{"verinha","marcelo","denise","guilherme","renato","michelle","rafael","barbara","lucas","ronaldo","nenem",});
 add(tp2);
 tp2.setRect(LEFT,AFTER+2,FILL,FILL);

When the user interface is Android, the tabs do not look good if the background is the same of the parent's. In this case, we force the background to be slighly darker. There are a few fields that you can use to change the color, like activeTabBackColor, useOnTabTheContainerColor and pressedColor. Important: starting in TotalCross 1.3, with Settings.fingerTouch=true, you CANNOT call setRect in your container. Otherwise, the flick and drag will not work and your container will be positioned incorrectly.

Nested Class Summary
- Nested classes/interfaces inherited from class totalcross.ui.Control
  Control.TranslucentShape

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`activeTabBackColor` This color is the one used to paint the background of the active tab.
`static boolean`	`allowFlick` Set to false to disable flicking between tabs.
`boolean`	`allSameWidth` Set to true to make all tabs have the same width.
`int`	`animationTime` Animation time when you click in the tab.
`int`	`arrowsColor` Set the arrows color right after the constructor and after calling setCaptionsColor, which also change this property.
`boolean`	`autoShrinkCaptions` Set to true to automatically shrink the captions to prevent using arrows.
`int`	`extraTabHeight` Define an extra height for the tabs.
`protected Flick`	`flick` The Flick object listens and performs flick animations on PenUp events when appropriate.
`boolean`	`flickIntoDisabledTabs` In finger touch devices, the user still can flick into a disabled tab.
`int`	`lastActiveTab` Stores the last active tab index, or -1 if none was previously selected.
`int`	`pressedColor` Set the color when the user clicks on the tab.
`boolean`	`showArrows` Enables or not the arrows if scroll is needed.
`static byte`	`TABS_BOTTOM` To be used on the setType method: specifies that the tabs will be placed on the bottom.
`static byte`	`TABS_NONE` To be used on the setType method: specifies that the tabs will be hidden and you will be responsible to change them.
`static byte`	`TABS_TOP` To be used on the setType method: specifies that the tabs will be placed on the top.
`int[]`	`tabsBackColor` Sets the colors used on each tab.
`int`	`unselectedTextColor` The color used for the text of unselected tabs.
`boolean`	`useBorder2` Set to true to enable the alternative tab border
`boolean`	`useOnTabTheContainerColor` Sets the tabs with the same colors of the container.

Fields inherited from class totalcross.ui.ClippedContainer
bagClipX0, bagClipXf, bagClipY0, bagClipYf, lastMid, verticalOnly

Fields inherited from class totalcross.ui.Container
alwaysEraseBackground, BACKGROUND_CYLINDRIC_SHADED, BACKGROUND_SHADED, BACKGROUND_SHADED_INV, BACKGROUND_SOLID, backgroundStyle, BORDER_LOWERED, BORDER_NONE, BORDER_RAISED, BORDER_ROUNDED, BORDER_SIMPLE, BORDER_TOP, borderColor, borderRadius, children, controlFound, finishedStart, ignoreOnAddAgain, ignoreOnRemove, insets, lastH, lastScreenWidth, lastW, lastX, lastY, numChildren, started, tabOrder, tail, TRANSITION_TIME

Fields inherited from class totalcross.ui.Control
AFTER, alphaValue, appId, appObj, asContainer, asWindow, backColor, BEFORE, BOTTOM, BOTTOM_OF, BRIGHTER_BACKGROUND, callListenersOnAllTargets, CENTER, CENTER_OF, clearValueInt, clearValueStr, DARKER_BACKGROUND, DP, effect, enableUpdateScreen, esce, eventsEnabled, FILL, fillColor, FIT, floating, fm, fmH, focusHandler, focusLess, focusOnPenDown, focusTraversable, font, FONTSIZE, foreColor, height, ignoreInsets, isHighlighting, isTablet, KEEP, keepDisabled, keepEnabled, LEFT, next, nextTabControl, npParts, offscreen, offscreen0, onEventFirst, parent, PARENTSIZE, PARENTSIZEMAX, PARENTSIZEMIN, PREFERRED, prev, RANGE, repositionAllowed, RIGHT, RIGHT_OF, SAME, SCREENSIZE, SCREENSIZEMAX, SCREENSIZEMIN, setFont, setH, setRel, setW, setX, SETX_NOT_SET, setY, tempW, textShadowColor, TOP, translucentShape, transparentBackground, uiAdjustmentsBasedOnFontHeightIsSupported, uiAndroid, UICONST, uiFlat, uiHolo, uiMaterial, uiVista, visible, width, WILL_RESIZE, x, y

Constructor Summary

Constructors
Constructor and Description
`TabbedContainer(Image[] imgCaptions)` Constructs a tab bar control with images as captions, using the given color as transparent color.
`TabbedContainer(Image[] imgCaptions, int transparentColor)` Constructor to keep compilation compatibility with TC 1; transparentColor is ignored.
`TabbedContainer(java.lang.String[] strCaptions)` Constructs a tab bar control with Strings as captions.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`canScrollContent(int direction, java.lang.Object target)` Checks if there is room to flick this container in the given direction.
`void`	`changeHighlighted(Container p, boolean forward)` Tranfer the focus between the containers on this TabbedContainer
`protected void`	`computeClipRect()`
`void`	`computeTabsRect()` compute the rects that represents each tab on the screen.
`void`	`flickEnded(boolean atPenDown)` Called when the flick animation is ended.
`boolean`	`flickStarted()` Called when the flick animation is started.
`Container`	`getActiveContainer()` Returns the container of the active tab.
`int`	`getActiveTab()` Returns the index of the selected tab
`int`	`getCaptionColor()` Gets the text color of the captions.
`Rect`	`getClientRect()` Returns the area excluding the tabs and borders for this TabbedContainer.
`protected void`	`getClientRect(Rect r)` Returns the area excluding the tabs and borders for this TabbedContainer.
`Container`	`getContainer(int i)` Returns the Container for tab i
`int`	`getEffectH()`
`int`	`getEffectW()`
`int`	`getEffectX()`
`int`	`getEffectY()`
`Flick`	`getFlick()` Returns the current flick object.
`void`	`getFocusableControls(Vector v)` Get a list of child controls of this container which are focus candidates
`int`	`getPreferredHeight()` Returns the caption height for this TabbedContainer.
`int`	`getPreferredWidth()` Returns the minimum width (based on the sizes of the captions) for this TabbedContainer
`int`	`getScrollPosition(int direction)` Returns the current position given the direction.
`int`	`getTabColor(int tab)` Returns the color of the given tab.
`int`	`getTabCount()` Returns the number of tabs.
`int`	`getType()` Returns the tabs type.
`Control`	`handleGeographicalFocusChangeKeys(KeyEvent ke)` Used by the main event loop to give the currently focused control an opportunity to act directly on the KeyEvent.
`void`	`initUI()` Called to initialize the User Interface of this container.
`boolean`	`isAtTop()` Deprecated. Use getType
`boolean`	`isEnabled(int tabIndex)` Returns if the given tab index is enabled.
`void`	`onAnimationFinished(ControlAnimation anim)`
`protected void`	`onBoundsChanged(boolean screenChanged)` Used internally.
`protected void`	`onColorsChanged(boolean colorsChanged)` Called after a setEnabled, setForeColor and setBackColor and when a control has been added to a Container.
`void`	`onEvent(Event event)` Called by the system to pass events to the tab bar control.
`void`	`onFontChanged()` Compute the rectangles of the tabs based on the selected (bolded) and unselected (plain) titles.
`void`	`onPaint(Graphics g)` Called by the system to draw the tab bar.
`void`	`reposition()` Reposition this control, calling again setRect with the original parameters.
`void`	`resizeHeight()` Resizes the height of each added container and sets the height of this TabbedContainer to the maximum height of the containers.
`boolean`	`scrollContent(int xDelta, int yDelta, boolean fromFlick)` Performs a relative move.
`void`	`setActiveIcon(Image newActiveIcon)` Sets the active icon.
`void`	`setActiveTab(int tab)` Sets the currently active tab, animating it.
`void`	`setActiveTab(int tab, boolean animate)` Sets the currently active tab.
`void`	`setBorderStyle(byte style)` Sets the type of border.
`void`	`setCaptionColor(int capColor)` Sets the text color of the captions in the tabs.
`void`	`setCaptions(java.lang.String[] caps)` Changes the tab captions.
`void`	`setContainer(int i, Container container)` Replaces the default created Container with the given one.
`void`	`setEnabled(boolean b)` Sets if this container and all childrens can or not accept events
`void`	`setEnabled(int tabIndex, boolean on)` Sets the given tab index as enabled or not.
`void`	`setHighlighting()` Only return to highlighting when we want
`void`	`setIcons(Image[] icons)` Set the given icons to appear at the top (or bottom, if TABS_BOTTOM) of a text TabbedContainer.
`void`	`setIcons(Image[] icons, Image activeIcon)` Set the given icons to appear at the top (or bottom, if TABS_BOTTOM) of a text TabbedContainer.
`void`	`setNinePatch(Image img, int side, int corner)` Set the NinePatch of the control.
`void`	`setType(byte type)` Sets the position of the tabs.
`boolean`	`wasScrolled()` Returns true if the control was scrolled since last pen down

Methods inherited from class totalcross.ui.ClippedContainer
paintChildren

Methods inherited from class totalcross.ui.Container
add, add, add, add, add, broadcastEvent, clear, fillBackground, findChild, findNearestChild, findNextFocusControl, getBorderRadius, getBorderStyle, getChildren, getChildrenCount, getFirstChild, getInsets, incLastX, incLastY, isPressed, moveFocusToNextControl, moveFocusToNextEditable, onAddAgain, onRemove, onSwapFinished, remove, removeAll, resize, resizeWidth, setBorderRadius, setFocusTraversable, setInsets, setPressColor, setPressed, swapToTopmostWindow

Methods inherited from class totalcross.ui.Control
_onEvent, addEnabledStateListener, addFocusListener, addFontChangeHandler, addGridListener, addHandler, addHighlightListener, addKeyListener, addListContainerListener, addMouseListener, addMultiTouchListener, addPenListener, addPressListener, addPushNotificationListener, addSizeChangeHandler, addTimer, addTimer, addTimerListener, addValueChangeHandler, addWindowListener, bringToFront, contains, drawTranslucentBackground, getAbsoluteRect, getBackColor, getDoEffect, getEventListeners, getFont, getForeColor, getGap, getGraphics, getHeight, getNext, getParent, getParentWindow, getPos, getPressedEvent, getPrev, getRect, getSize, getTextShadowColor, getWidth, getX, getX2, getY, getY2, hadParentScrolled, hasFocus, internalSetEnabled, intXYWH, isActionEvent, isChildOf, isDisplayed, isEnabled, isFloating, isInsideOrNear, isObscured, isTopMost, isVisible, isVisibleAndInside, onWindowPaintFinished, post, postEvent, postPressedEvent, releaseScreenShot, removeEnabledStateListener, removeFocusListener, removeGridListener, removeHandler, removeHighlightListener, removeKeyListener, removeListContainerListener, removeMouseListener, removeMultiTouchListener, removePenListener, removePressListener, removePushNotificationListener, removeTimer, removeTimerListener, removeWindowListener, repaint, repaintNow, reposition, repositionChildren, requestFocus, resetSetPositions, resetStyle, safeRepaintNow, safeUpdateScreen, sendToBack, setBackColor, setBackForeColors, setDoEffect, setFloating, setFocusLess, setFont, setForeColor, setNinePatch, setRect, setRect, setRect, setRect, setSet, setTextShadowColor, setTranslucent, setVisible, showTip, takeInitialScreenShot, takeScreenShot, translateFromOrigin, uiStyleChanged, updateScreen, updateTemporary, willOpenKeyboard

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - arrowsColor
```
public int arrowsColor
```
    Set the arrows color right after the constructor and after calling setCaptionsColor, which also change this property.
  - useBorder2
```
public boolean useBorder2
```
    Set to true to enable the alternative tab border
  - autoShrinkCaptions
```
public boolean autoShrinkCaptions
```
    Set to true to automatically shrink the captions to prevent using arrows. Works only for String-based captions.
  - showArrows
```
public boolean showArrows
```
    Enables or not the arrows if scroll is needed.
  - activeTabBackColor
```
public int activeTabBackColor
```
    This color is the one used to paint the background of the active tab. This is specially useful for image tabs.
    
    Since:
    
    SuperWaba 5.64
    
    See Also:
    
    Control.setBackColor(int), useOnTabTheContainerColor, tabsBackColor
  - tabsBackColor
```
public int[] tabsBackColor
```
    Sets the colors used on each tab. You must create and set the array with the colors. Pass -1 to keep the original color. This array has precedence over the other ways that changes colors, except activeTabBackColor.
    
    Since:
    
    TotalCross 1.52
    
    See Also:
    
    Control.setBackColor(int), useOnTabTheContainerColor, activeTabBackColor
  - useOnTabTheContainerColor
```
public boolean useOnTabTheContainerColor
```
    Sets the tabs with the same colors of the container.
    
    Since:
    
    SuperWaba 5.72
    
    See Also:
    
    Control.setBackColor(int), tabsBackColor, activeTabBackColor
  - lastActiveTab
```
public int lastActiveTab
```
    Stores the last active tab index, or -1 if none was previously selected.
    
    Since:
    
    SuperWaba 4.21
  - flickIntoDisabledTabs
```
public boolean flickIntoDisabledTabs
```
    In finger touch devices, the user still can flick into a disabled tab. To disable this behaviour, set this flag to false; so when a disabled tab is reached, the user will not be able to flick into it, and will have to click on an enabled tab to continue flicking.
    
    Since:
    
    TotalCross 1.3
  - TABS_TOP
```
public static final byte TABS_TOP
```
    To be used on the setType method: specifies that the tabs will be placed on the top.
    
    See Also:
    
    Constant Field Values
  - TABS_BOTTOM
```
public static final byte TABS_BOTTOM
```
    To be used on the setType method: specifies that the tabs will be placed on the bottom.
    
    See Also:
    
    Constant Field Values
  - TABS_NONE
```
public static final byte TABS_NONE
```
    To be used on the setType method: specifies that the tabs will be hidden and you will be responsible to change them.
    
    See Also:
    
    Constant Field Values
  - pressedColor
```
public int pressedColor
```
    Set the color when the user clicks on the tab.
    
    Since:
    
    TotalCross 1.3.4
  - allSameWidth
```
public boolean allSameWidth
```
    Set to true to make all tabs have the same width.
    
    Since:
    
    TotalCross 1.3.4
  - extraTabHeight
```
public int extraTabHeight
```
    Define an extra height for the tabs. Use something line fmH/2. Required when setIcons is called.
    
    Since:
    
    TotalCross 1.3.4
    
    See Also:
    
    setIcons(Image[])
  - unselectedTextColor
```
public int unselectedTextColor
```
    The color used for the text of unselected tabs. Defaults to the foreground color.
  - flick
```
protected Flick flick
```
    The Flick object listens and performs flick animations on PenUp events when appropriate.
  - allowFlick
```
public static boolean allowFlick
```
    Set to false to disable flicking between tabs. You can still switch between the tabs by clicking on them. Sample:
```
      TabbedContainer.allowFlick = false;
      TabbedContainer tc = new TabbedContainer(caps);
      TabbedContainer.allowFlick = true;
 
```
  - animationTime
```
public int animationTime
```
    Animation time when you click in the tab. Set to 0 to disable animation.
- Constructor Detail
  - TabbedContainer
```
public TabbedContainer(java.lang.String[] strCaptions)
```
    Constructs a tab bar control with Strings as captions.
  - TabbedContainer
```
public TabbedContainer(Image[] imgCaptions,
                       int transparentColor)
```
    Constructor to keep compilation compatibility with TC 1; transparentColor is ignored.
  - TabbedContainer
```
public TabbedContainer(Image[] imgCaptions)
```
    Constructs a tab bar control with images as captions, using the given color as transparent color. If you don't want to use transparent colors, just pass -1 to the color.
- Method Detail
  - computeClipRect
```
protected void computeClipRect()
```
    Overrides:
    
    computeClipRect in class ClippedContainer
  - initUI
```
public void initUI()
```
    Description copied from class: Container
    
    Called to initialize the User Interface of this container. This differs from the onAddAgain method by that this method is called only once, at the first time the control is added to the parent. When the container is being setup, the initUI method is called; then, the onAddAgain is called every time the container is added again.
    
    Overrides:
    
    initUI in class Container
  - getTabCount
```
public int getTabCount()
```
    Returns the number of tabs.
    
    Since:
    
    TotalCross 1.15
  - setEnabled
```
public void setEnabled(int tabIndex,
                       boolean on)
```
    Sets the given tab index as enabled or not. When a tab is disabled, it is displayed faded, and if the user clicks on it, nothing happens. However, you still can activate it by calling setActiveTab. If there are no tabs enabled, the current tab will be made active and the controls will also be enabled. So, if you plan to disable all tabs, better disable the TabbedContainer control instead.
    
    Parameters:
    
    on - If true, the tab is enabled, if false it is disabled.
    
    tabIndex - The tab's index (0 to count-1)
    
    Since:
    
    TotalCross 1.01
    
    See Also:
    
    setActiveTab(int)
  - isEnabled
```
public boolean isEnabled(int tabIndex)
```
    Returns if the given tab index is enabled.
    
    Since:
    
    TotalCross 1.01
  - setActiveIcon
```
public void setActiveIcon(Image newActiveIcon)
```
    Sets the active icon.
  - setIcons
```
public void setIcons(Image[] icons)
```
    Set the given icons to appear at the top (or bottom, if TABS_BOTTOM) of a text TabbedContainer. The icon images must be squared. You must also set the extraTabHeight, because the icons will be resized to (extraTabHeight-fmH) in both directions.
    
    Since:
    
    TotalCross 1.3.4
  - setIcons
```
public void setIcons(Image[] icons,
                     Image activeIcon)
```
    Set the given icons to appear at the top (or bottom, if TABS_BOTTOM) of a text TabbedContainer. The icon images must be squared. You must also set the extraTabHeight, because the icons will be resized to (extraTabHeight-fmH) in both directions. Also, sets the active icon.
  - setType
```
public void setType(byte type)
```
    Sets the position of the tabs. use constants TABS_TOP or TABS_BOTTOM. Since the tabs are not changed dinamicaly, this method must be called after the constructor.
  - getType
```
public int getType()
```
    Returns the tabs type.
  - getContainer
```
public Container getContainer(int i)
```
    Returns the Container for tab i
  - setBorderStyle
```
public void setBorderStyle(byte style)
```
    Sets the type of border. Currently, only the Window.NO_BORDER and Window.RECT_BORDER are supported. NO_BORDER only draws the line under the tabs.
    
    Overrides:
    
    setBorderStyle in class Container
    
    See Also:
    
    Container.BORDER_NONE, Container.BORDER_LOWERED, Container.BORDER_RAISED, Container.BORDER_SIMPLE, Container.BORDER_TOP, Container.BORDER_ROUNDED
  - setContainer
```
public void setContainer(int i,
                         Container container)
```
    Replaces the default created Container with the given one. This way you can avoid adding a container to a container and, as such, waste memory. Note that you must do this before the first setRect for this TabbedContainer; otherwise, you must explicitly call setRect again to update the added container bounds
  - setActiveTab
```
public void setActiveTab(int tab)
```
    Sets the currently active tab, animating it. A PRESSED event will be posted to the given tab if it is not the currently active tab; then, the containers will be switched.
  - setActiveTab
```
public void setActiveTab(int tab,
                         boolean animate)
```
    Sets the currently active tab. A PRESSED event will be posted to the given tab if it is not the currently active tab; then, the containers will be switched. The animation is optional and can also be defined with @see
  - onAnimationFinished
```
public void onAnimationFinished(ControlAnimation anim)
```
    Specified by:
    
    onAnimationFinished in interface ControlAnimation.AnimationFinished
  - getActiveTab
```
public int getActiveTab()
```
    Returns the index of the selected tab
  - getActiveContainer
```
public Container getActiveContainer()
```
    Returns the container of the active tab.
    
    Since:
    
    TotalCross 1.2
  - getPreferredHeight
```
public int getPreferredHeight()
```
    Returns the caption height for this TabbedContainer. Note that it is not possible to compute the correct height of each container, since they will be added AFTER this TabbedContainer has their bounds set. So, you should actually use some other way to specify the bounds, like FILL or FIT; using PREFERRED in the height of setRect will make your application abort.
    
    Overrides:
    
    getPreferredHeight in class Control
  - getPreferredWidth
```
public int getPreferredWidth()
```
    Returns the minimum width (based on the sizes of the captions) for this TabbedContainer
    
    Overrides:
    
    getPreferredWidth in class Control
  - setNinePatch
```
public void setNinePatch(Image img,
                         int side,
                         int corner)
```
    Description copied from class: Control
    
    Set the NinePatch of the control. This is used to draw the background image.
    
    Overrides:
    
    setNinePatch in class Control
    
    Parameters:
    
    img - The image to make the NinePatch. The image must be on a NinePatch format.
    
    side - The size, in pixels, of the NinePatch's corner
    
    corner - The size, in pixels, of the NinePatch's side.
  - onBoundsChanged
```
protected void onBoundsChanged(boolean screenChanged)
```
    Used internally. resizes all the containers and add the arrows if scroll is needed.
    
    Overrides:
    
    onBoundsChanged in class Control
    
    Parameters:
    
    screenChanged - If the bounds were changed due to a screen change (rotation, collapse)
  - setEnabled
```
public void setEnabled(boolean b)
```
    Description copied from class: Container
    
    Sets if this container and all childrens can or not accept events
    
    Overrides:
    
    setEnabled in class Container
  - computeTabsRect
```
public void computeTabsRect()
```
    compute the rects that represents each tab on the screen.
  - onFontChanged
```
public void onFontChanged()
```
    Compute the rectangles of the tabs based on the selected (bolded) and unselected (plain) titles.
    
    Overrides:
    
    onFontChanged in class Control
  - onColorsChanged
```
protected void onColorsChanged(boolean colorsChanged)
```
    Description copied from class: Control
    
    Called after a setEnabled, setForeColor and setBackColor and when a control has been added to a Container. If colorsChanged is true, it was called from setForeColor/setBackColor/Container.add; otherwise, it was called from setEnabled
    
    Overrides:
    
    onColorsChanged in class Container
  - onPaint
```
public void onPaint(Graphics g)
```
    Called by the system to draw the tab bar.
    
    Overrides:
    
    onPaint in class Container
    
    Parameters:
    
    g - the graphics object for drawing
    
    See Also:
    
    Graphics
  - getEffectW
```
public int getEffectW()
```
    Overrides:
    
    getEffectW in class Control
  - getEffectH
```
public int getEffectH()
```
    Overrides:
    
    getEffectH in class Control
  - getEffectX
```
public int getEffectX()
```
    Overrides:
    
    getEffectX in class Control
  - getEffectY
```
public int getEffectY()
```
    Overrides:
    
    getEffectY in class Control
  - getTabColor
```
public int getTabColor(int tab)
```
    Returns the color of the given tab.
    
    Since:
    
    TotalCross 1.52
  - setCaptionColor
```
public void setCaptionColor(int capColor)
```
    Sets the text color of the captions in the tabs.
  - getCaptionColor
```
public int getCaptionColor()
```
    Gets the text color of the captions. return a grayed value if this control is not enabled.
  - getClientRect
```
public Rect getClientRect()
```
    Returns the area excluding the tabs and borders for this TabbedContainer. Note: do not change the returning rect object !
    
    Overrides:
    
    getClientRect in class Container
    
    See Also:
    
    Container.getClientRect(Rect)
  - getClientRect
```
protected void getClientRect(Rect r)
```
    Returns the area excluding the tabs and borders for this TabbedContainer. In this version, you provide the created Rect to be filled with the coords.
    
    Overrides:
    
    getClientRect in class Container
  - onEvent
```
public void onEvent(Event event)
```
    Called by the system to pass events to the tab bar control.
    
    Overrides:
    
    onEvent in class Control
    
    Parameters:
    
    event - the event to process
    
    See Also:
    
    Event, KeyEvent, PenEvent
  - changeHighlighted
```
public void changeHighlighted(Container p,
                              boolean forward)
```
    Tranfer the focus between the containers on this TabbedContainer
    
    Overrides:
    
    changeHighlighted in class Control
  - setHighlighting
```
public void setHighlighting()
```
    Only return to highlighting when we want
    
    Overrides:
    
    setHighlighting in class Container
  - reposition
```
public void reposition()
```
    Description copied from class: Control
    
    Reposition this control, calling again setRect with the original parameters.
    
    Overrides:
    
    reposition in class Control
  - getFocusableControls
```
public void getFocusableControls(Vector v)
```
    Description copied from class: Container
    
    Get a list of child controls of this container which are focus candidates
    
    Overrides:
    
    getFocusableControls in class Container
    
    Parameters:
    
    v - A vector into which to add the focus candidates.
  - handleGeographicalFocusChangeKeys
```
public Control handleGeographicalFocusChangeKeys(KeyEvent ke)
```
    Description copied from class: Control
    
    Used by the main event loop to give the currently focused control an opportunity to act directly on the KeyEvent.
    
    Overrides:
    
    handleGeographicalFocusChangeKeys in class Control
    
    Parameters:
    
    ke - The KeyEvent to be processed
    
    Returns:
    
    The control that should get focus as a result of this KeyEvent. Null if this control did not handle the KeyEvent.
    
    See Also:
    
    Settings.geographicalFocus
  - isAtTop
```
@Deprecated
public boolean isAtTop()
```
    Deprecated. Use getType
    
    Returns true of the type is set to TABS_TOP.
  - resizeHeight
```
public void resizeHeight()
```
    Resizes the height of each added container and sets the height of this TabbedContainer to the maximum height of the containers.
    
    Overrides:
    
    resizeHeight in class Container
    
    See Also:
    
    Container.resizeWidth(), Container.resize()
  - flickStarted
```
public boolean flickStarted()
```
    Description copied from interface: Scrollable
    
    Called when the flick animation is started.
    
    Specified by:
    
    flickStarted in interface Scrollable
  - flickEnded
```
public void flickEnded(boolean atPenDown)
```
    Description copied from interface: Scrollable
    
    Called when the flick animation is ended.
    
    Specified by:
    
    flickEnded in interface Scrollable
    
    Parameters:
    
    atPenDown - Flag indicating if the animation ended due to a pendown event.
  - canScrollContent
```
public boolean canScrollContent(int direction,
                                java.lang.Object target)
```
    Description copied from interface: Scrollable
    
    Checks if there is room to flick this container in the given direction.
    
    Specified by:
    
    canScrollContent in interface Scrollable
    
    Parameters:
    
    direction - The direction we want to flick given by one of the following constants:
    
    target - The target of the series of PEN events that triggered this flick attempt.
    
    Returns:
    
    true if the container can flick in the indicated direction.
  - scrollContent
```
public boolean scrollContent(int xDelta,
                             int yDelta,
                             boolean fromFlick)
```
    Description copied from interface: Scrollable
    
    Performs a relative move.
    
    Specified by:
    
    scrollContent in interface Scrollable
    
    Parameters:
    
    xDelta - The relative amount of pixels to move in the X axis.
    
    yDelta - The relative amount of pixels to move in the Y axis.
  - getScrollPosition
```
public int getScrollPosition(int direction)
```
    Description copied from interface: Scrollable
    
    Returns the current position given the direction. Used on page scrolls.
    
    Specified by:
    
    getScrollPosition in interface Scrollable
  - getFlick
```
public Flick getFlick()
```
    Description copied from interface: Scrollable
    
    Returns the current flick object.
    
    Specified by:
    
    getFlick in interface Scrollable
  - wasScrolled
```
public boolean wasScrolled()
```
    Description copied from interface: Scrollable
    
    Returns true if the control was scrolled since last pen down
    
    Specified by:
    
    wasScrolled in interface Scrollable
  - setCaptions
```
public void setCaptions(java.lang.String[] caps)
```
    Changes the tab captions. The new array must have the same length or an exception is thrown.

Class TabbedContainer

Nested Class Summary

Nested classes/interfaces inherited from class totalcross.ui.Control

Field Summary

Fields inherited from class totalcross.ui.ClippedContainer

Fields inherited from class totalcross.ui.Container

Fields inherited from class totalcross.ui.Control

Constructor Summary

Method Summary

Methods inherited from class totalcross.ui.ClippedContainer

Methods inherited from class totalcross.ui.Container

Methods inherited from class totalcross.ui.Control

Methods inherited from class java.lang.Object

Field Detail

arrowsColor

useBorder2

autoShrinkCaptions

showArrows

activeTabBackColor

tabsBackColor

useOnTabTheContainerColor

lastActiveTab

flickIntoDisabledTabs

TABS_TOP

TABS_BOTTOM

TABS_NONE

pressedColor

allSameWidth

extraTabHeight

unselectedTextColor

flick

allowFlick

animationTime

Constructor Detail

TabbedContainer

TabbedContainer

TabbedContainer

Method Detail

computeClipRect

initUI

getTabCount

setEnabled

isEnabled

setActiveIcon

setIcons

setIcons

setType

getType

getContainer

setBorderStyle

setContainer

setActiveTab

setActiveTab

onAnimationFinished

getActiveTab

getActiveContainer

getPreferredHeight

getPreferredWidth

setNinePatch

onBoundsChanged

setEnabled

computeTabsRect

onFontChanged

onColorsChanged

onPaint

getEffectW

getEffectH

getEffectX

getEffectY

getTabColor

setCaptionColor

getCaptionColor

getClientRect

getClientRect

onEvent

changeHighlighted

setHighlighting

reposition

getFocusableControls

handleGeographicalFocusChangeKeys