javauis/lcdui_akn/lcdui/src/Cmidformrow.cpp
author Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
Thu, 19 Aug 2010 09:48:13 +0300
branchRCL_3
changeset 24 6c158198356e
parent 14 04becd199f91
permissions -rw-r--r--
Revision: v2.2.9 Kit: 201033

/*
* Copyright (c) 2003-2007 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of "Eclipse Public License v1.0"
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description:  Implements the Form LCDUI component.
*
*/


// For LyaoutMirrored() method.
#include <AknUtils.h>

#include "CMIDFormRow.h"
// CMIDForm API for iForm
#include "CMIDForm.h"
// API for items on rows
#include "CMIDControlItem.h"
#include "CMIDItemLabel.h"

#ifdef RD_JAVA_S60_RELEASE_9_2
#include "CMIDLabelContainerItem.h"

#include <AknsUtils.h>
#include <aknlayoutscalable_avkon.cdl.h>

// CONSTANTS
// Default for Form separator line color's alpha value, used if not
// found from skin.
const TInt KDefaultSeparatorAlpha = 32;
const TInt KDefaultSeparatorColor = 0;
#endif // RD_JAVA_S60_RELEASE_9_2

CMIDFormRow* CMIDFormRow::NewL(CMIDForm& aForm)
{
    CMIDFormRow* self = new(ELeave) CMIDFormRow(aForm);
    CleanupStack::PushL(self);
    self->ActivateL();
    CleanupStack::Pop(self);
    return self;
}

CMIDFormRow::~CMIDFormRow()
{
    TInt i;
    for (i=0; i < iItems.Count(); i++)
    {
        if (CMIDForm::IsLabelContainerItem(*(iItems[i])))
        {
            delete iItems[i];
        }
        else if (CMIDForm::IsSpacerUsedForFormatting(*(iItems[i])))
        {
            delete iItems[i];
        }
    }
    iItems.Reset();
    iItems.Close();
}

TInt CMIDFormRow::CountComponentControls() const
{
    return iItems.Count();
}

CCoeControl* CMIDFormRow::ComponentControl(TInt aIndex) const
{
    return iItems[aIndex];
}

#ifdef RD_JAVA_S60_RELEASE_9_2
void CMIDFormRow::Draw(const TRect& /*aRect*/) const
{
    if (iSeparator)
    {
        CWindowGc& gc = SystemGc();
        MAknsSkinInstance* skin = AknsUtils::SkinInstance();
        gc.SetBrushStyle(CGraphicsContext::ENullBrush);
        gc.SetPenStyle(CGraphicsContext::ESolidPen);

        TRgb color;
        TInt err = AknsUtils::GetCachedColor(skin,
                                             color,
                                             KAknsIIDQsnTextColors,
                                             EAknsCIQsnTextColorsCG6);
        if (err != KErrNone)
        {
            color = KDefaultSeparatorColor;
        }

        TRgb colorFromSkin;
        // Get alpha value from skin, if not successful, default is used.
        err = AknsUtils::GetCachedColor(skin ? skin : AknsUtils::SkinInstance(),
                                        colorFromSkin,
                                        KAknsIIDQsnLineColors,
                                        EAknsCIQsnLineColorsCG15);

        color.SetAlpha(!err ? colorFromSkin.Red() : KDefaultSeparatorAlpha);
        gc.SetDrawMode(CGraphicsContext::EDrawModePEN);
        gc.SetPenColor(color);

        // Draw line to upper part of the form row.
        TRect lineRect(Rect());
        // Using same margin value with avkon list box separator lines.
        TInt gap = AknLayoutScalable_Avkon::listscroll_gen_pane(0).LayoutLine().it;
        lineRect.Shrink(gap, 0);
        lineRect.Move(0, 1);
        gc.DrawLine(TPoint(lineRect.iTl.iX, lineRect.iTl.iY),
                    TPoint(lineRect.iBr.iX, lineRect.iTl.iY));
    }
}
#endif // RD_JAVA_S60_RELEASE_9_2

void CMIDFormRow::SizeChanged()
{
    TInt xOff = 0;

    TSize size(0,0);

    TInt i;
    for (i=0; i < iItems.Count(); i++)
    {
        CMIDControlItem& ci = *(iItems[i]);
        size.iWidth += ci.Size().iWidth;
        if (ci.Size().iHeight > size.iHeight)
        {
            size.iHeight = ci.Size().iHeight;
        }
    }

    if (iAlignment == MMIDItem::ERight)
    {
        xOff = iForm.Width() - size.iWidth;
        // If it is mirrored layout, we need translate a row.
        if (AknLayoutUtils::LayoutMirrored())
        {
            xOff -= iForm.GetMidpNaviPos();
        }
    }

    if (iAlignment == MMIDItem::ECenter)
    {
        xOff = (iForm.Width() - size.iWidth) / 2;
    }

    for (i=0; i < iItems.Count(); i++)
    {
        CMIDControlItem& ci = *(iItems[i]);
        TInt yOff = 0;
        if (CMIDForm::LayoutBottom(ci))
        {
            yOff = size.iHeight - ci.Size().iHeight;
        }
        if (CMIDForm::LayoutVerticalCenter(ci))
        {
            yOff = (size.iHeight - ci.Size().iHeight) / 2;
        }

        // Form left margin is added in the beginning of each row
        TPoint newPosition = Position() + TPoint(xOff, yOff);
        TSize itemSize = ci.Size();
        TRect itemRect = TRect(newPosition, itemSize);
        ci.SetRect(itemRect);
        xOff += ci.Size().iWidth;
    }
}

TSize CMIDFormRow::MinimumSize()
{
    if (iItems.Count() == 0)
    {
        return iEmptyRowSize;
    }

    TInt width = 0;
    TInt height = 0;

    for (TInt i=0; i < iItems.Count(); i++)
    {
        CMIDControlItem& ci = *(iItems[i]);

        width += CMIDForm::LayoutShrink(ci) ? ci.MinimumSize().iWidth : ci.PreferredSize().iWidth;

        if (CMIDForm::LayoutVerticalShrink(ci))
        {
            if (height < ci.MinimumSize().iHeight)
            {
                height = ci.MinimumSize().iHeight;
            }
        }
        else
        {
            if (height < ci.PreferredSize().iHeight)
            {
                height = ci.PreferredSize().iHeight;
            }
        }
    }
    return TSize(width, height);
}

void CMIDFormRow::AppendL(CMIDControlItem* aItem)
{
    if (iForm.InitialAlignment() == MMIDItem::ELeft)
    {
        User::LeaveIfError(iItems.Append(aItem));
    }
    else
    {
        User::LeaveIfError(iItems.Insert(aItem, 0));
    }
    iCurrentWidth += aItem->Size().iWidth;

#ifdef RD_JAVA_S60_RELEASE_9_2
    SetSeparator();
#endif // RD_JAVA_S60_RELEASE_9_2   
}

void CMIDFormRow::SetAlignment(MMIDItem::TLayout aAlignment)
{
    ASSERT((aAlignment == MMIDItem::ELeft) || (aAlignment == MMIDItem::ERight) || (aAlignment == MMIDItem::ECenter));
    iAlignment = aAlignment;
}

/** */
void CMIDFormRow::SizeItemsL()
{
    TSize minSize = MinimumSize();

    // size the widths first
    TInt availableWidth = iForm.Width() - minSize.iWidth;
    // equation is also allowed - resizing when extra space is same as allowed
    if (availableWidth >= 0)
    {
        TInt totalExtraWidth = 0;
        for (TInt j=0; j < iItems.Count(); j++)
        {
            CMIDControlItem& ci = *(iItems[j]);
            if (CMIDForm::LayoutShrink(ci))
            {
                totalExtraWidth += ci.PreferredSize().iWidth - ci.MinimumSize().iWidth;
            }
        }

        if (availableWidth > totalExtraWidth)
        {
            // just give all items what they want
            for (TInt j=0; j < iItems.Count(); j++)
            {
                CMIDControlItem& ci = *(iItems[j]);
                ci.SetSizeQuiet(ci.PreferredSize());
            }

            availableWidth -= totalExtraWidth;
        }
        else
        {
            // distribute the size
            TReal scaleFactor;
            if (availableWidth == totalExtraWidth)
            {
                scaleFactor = 1;
            }
            else
            {
                if (totalExtraWidth != 0)
                {
                    scaleFactor = TReal(availableWidth) / TReal(totalExtraWidth);
                }
                else
                {
                    scaleFactor = 1;
                }
            }

            for (TInt j=0; j < iItems.Count(); j++)
            {
                CMIDControlItem& ci = *(iItems[j]);

                if (CMIDForm::LayoutShrink(ci))
                {
                    TInt minAndPreferredDif = ci.PreferredSize().iWidth - ci.MinimumSize().iWidth;
                    TInt newMinAndPreferredDif = TInt(scaleFactor * TReal(minAndPreferredDif));
                    TInt newWidth = ci.MinimumSize().iWidth + Min(newMinAndPreferredDif, minAndPreferredDif);
                    availableWidth -= Min(newMinAndPreferredDif, minAndPreferredDif);
                    ci.SetSizeQuiet(TSize(newWidth, ci.Size().iHeight));
                }
                else
                {
                    ci.SetSizeQuiet(TSize(ci.PreferredSize().iWidth, ci.Size().iHeight));
                }
            }
        }
        // note: should probably do another pass through to make sure the above step
        // went ok and didn't suffer from rounding errors (ie that the Shrink items didn't
        // end up smaller than their preferred size (if we have size left over)

        // loop through and expand the items with Expand layout
        if (availableWidth > 0)
        {
            TInt numExpand = 0;
            // count the items with Expand layout
            for (TInt j=0; j < iItems.Count(); j++)
            {
                CMIDControlItem& ci = *(iItems[j]);

                if (CMIDForm::LayoutExpand(ci))
                {
                    numExpand++;
                }
            }
            if (numExpand > 0)
            {
                TInt addedSize = availableWidth / numExpand;
                TInt expandIdx = -1;

                for (TInt j=0; j < iItems.Count(); j++)
                {
                    CMIDControlItem& ci = *(iItems[j]);

                    if (CMIDForm::LayoutExpand(ci))
                    {
                        ci.SetSizeQuiet(ci.Size() + TSize(addedSize, 0));
                        availableWidth -= addedSize;
                        expandIdx = j;
                        // at the end of the loop this will hold the last expanded
                        // item. At that time we can check if we still have extra
                        // space remaining and give it to the item at this index
                    }
                }
                if (availableWidth > 0)
                {
                    // if we still have extra width due to rounding error just give it to the last item
                    iItems[expandIdx]->SetSizeQuiet(iItems[expandIdx]->Size() + TSize(availableWidth, 0));
                }
            }
        }
    }


    // the widths have been calculated. This could have changed the height
    // due to for example label wrapping so ask the control to check
    // the new width.
    TInt j;
    for (j=0; j < iItems.Count(); j++)
    {
        CMIDControlItem& ci = *(iItems[j]);
        ci.AdjustToNewWidthL(ci.Size().iWidth);
    }

    // now size the heights

    // first find the row height
    TInt rowHeight = 0;
    for (j=0; j < iItems.Count(); j++)
    {
        CMIDControlItem& ci = *(iItems[j]);

        TInt height = ci.PreferredSize().iHeight;
        if (CMIDForm::LayoutVerticalShrink(ci))
        {
            height = ci.MinimumSize().iHeight;
        }
        if (height > rowHeight)
        {
            rowHeight = height;
        }
    }

    if (iItems.Count() == 0)
    {//if not items use empty row height
        rowHeight = iEmptyRowSize.iHeight;
    }

    // now set the row heights
    for (j=0; j < iItems.Count(); j++)
    {
        CMIDControlItem& ci = *(iItems[j]);

        // first set the size normally, then change it based on shrink and expand directives
        ci.SetSizeQuiet(TSize(ci.Size().iWidth, ci.PreferredSize().iHeight));
        if (CMIDForm::LayoutVerticalShrink(ci))
        {
            TInt height = Min(ci.PreferredSize().iHeight, rowHeight);
            ci.SetSizeQuiet(TSize(ci.Size().iWidth, height));
        }
        if (CMIDForm::LayoutVerticalExpand(ci))
        {
            ci.SetSizeQuiet(TSize(ci.Size().iWidth, rowHeight));
        }

        ci.AdjustToSizeL(ci.Size());
    }

    // set the size of the row
    SetSize(TSize(iForm.Width(), rowHeight));
}

TInt CMIDFormRow::NumItems()
{
    return iItems.Count();
}

TInt CMIDFormRow::Find(const CMIDControlItem* aItem) const
{
    for (TInt i=0; i < iItems.Count(); i++)
    {
        if (aItem == iItems[i])
        {
            return i;
        }
    }

    return KErrNotFound;
}

CMIDControlItem* CMIDFormRow::Item(TInt aIndex)
{
    ASSERT(aIndex >= 0 && aIndex < iItems.Count());
    return iItems[aIndex];
}

TBool CMIDFormRow::HasFocusableItemOnOrAboveScreen()
{
    for (TInt i=0; i < iItems.Count(); i++)
    {
        if (iItems[i]->IsSelectable())
        {
            TRect rect = iItems[i]->Rect();
            if (rect.iTl.iY < iForm.Height())
            {
                return ETrue;
            }
        }
    }
    return EFalse;
}

TBool CMIDFormRow::HasFocusableItemOnOrBelowScreen()
{
    for (TInt i=0; i < iItems.Count(); i++)
    {
        if (iItems[i]->IsSelectable())
        {
            TRect rect = iItems[i]->Rect();
            if (rect.iBr.iY >= 0)
            {
                return ETrue;
            }
        }
    }
    return EFalse;
}

CMIDControlItem* CMIDFormRow::FirstFocusableItemOnScreen()
{
    TInt idx = -1;
    while (++idx < iItems.Count())
    {
        if (iItems[idx]->IsSelectable())
        {
            TRect rect = iItems[idx]->Rect();
            if (iForm.RectPartiallyVisible(rect))
            {
                return iItems[idx];
            }
        }
    }
    return NULL;
}

CMIDControlItem* CMIDFormRow::FirstFocusableItem()
{
    TInt idx = -1;
    while (++idx < iItems.Count())
    {
        if (iItems[idx]->IsSelectable())
        {
            return iItems[idx];
        }
    }
    return NULL;
}

CMIDControlItem* CMIDFormRow::LastFocusableItem()
{
    TInt idx = iItems.Count();
    while (--idx >= 0)
    {
        if (iItems[idx]->IsSelectable())
        {
            return iItems[idx];
        }
    }
    return NULL;
}

// typically just used when cleaning up. This won't cause a layout.
TBool CMIDFormRow::RemoveItemIfExists(CMIDControlItem& aItem)
{
    TInt i = -1;
    while (++i < iItems.Count())
    {
        if (&aItem == iItems[i])
        {
            iItems.Remove(i);
            return ETrue;
        }
    }

    return EFalse;
}

TInt CMIDFormRow::CurrentWidth()
{
    return iCurrentWidth;
}

CMIDFormRow::CMIDFormRow(CMIDForm& aForm)
        :iForm(aForm)
{
#ifdef RD_SCALABLE_UI_V2
    SetAllowStrayPointers();
#endif // RD_SCALABLE_UI_V2
}

void CMIDFormRow::ConstructL()
{
}

/**
 *  Returns true if this row has at least an item which is not a spacer
 */
TBool CMIDFormRow::HasNonSpacerItems() const
{
    TBool ret = EFalse;

    TInt i = -1;
    while (++i < iItems.Count())
    {
        if (iItems[i]->Type() != MMIDComponent::ESpacer)
        {
            ret = ETrue;
            break;
        }
    }

    return ret;
}

#ifdef RD_JAVA_S60_RELEASE_9_2
void CMIDFormRow::SetSeparator()
{
    // Separator is not drawn above the first row.
    if (iForm.FormRowIndex(this) <= 0)
    {
        iSeparator = EFalse;
        return;
    }
    else
    {
        iSeparator = ETrue;
    }

    // Separator is not drawn if the rows includes only spacers
    if (!HasNonSpacerItems())
    {
        iSeparator = EFalse;
        return;
    }

    if (Item(0)->HasLabel())
    {
        iSeparator = ETrue;
        return;
    }
    else
    {
        // If the first item is other than StringItem then draw separator.
        if (!CMIDForm::IsLabelContainerItem(*Item(0)))
        {
            iSeparator = ETrue;
            return;
        }
        else
        {
            // If Button type StringItem then separator is drawn.
            if (CMIDForm::IsStringItemButton(*Item(0)))
            {
                iSeparator = ETrue;
                return;
            }

            CMIDLabelContainerItem* ucsi = static_cast<CMIDLabelContainerItem*>(Item(0));
            // If the first item is label, then draw separator.
            if (ucsi && !ucsi->IsStringItemContent())
            {
                iSeparator = ETrue;
                return;
            }
            else
            {
                // If the last item in the previous row is StringItem,
                // then do not draw separator.
                TInt prevRowIndex = iForm.FormRowIndex(this) - 1;
                if (prevRowIndex >= 0)
                {
                    CMIDFormRow* prevRow = iForm.FormRow(prevRowIndex);
                    TInt index = 0;
                    if (prevRow)
                    {
                        index = prevRow->NumItems();

                        // If there are items in previous row check if row is StrinItem
                        if (index >= 1)
                        {
                            CMIDControlItem* lastPrevItem = prevRow->Item(index - 1);

                            if (lastPrevItem && CMIDForm::IsLabelContainerItem(*lastPrevItem))
                            {
                                iSeparator = EFalse;
                                return;
                            }
                            else
                            {
                                iSeparator = ETrue;
                                return;
                            }
                        }
                        else
                        {
                            iSeparator = ETrue;
                            return;
                        }
                    }
                }
            }
        }
    }
}
#endif // RD_JAVA_S60_RELEASE_9_2
// End of File