/*

* Copyright (c) 2003-2006 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:  The CMIDChoiceGroup control container. Owns and manipulates

*                the choicegroup model and creates / deletes the actual

*                control as needed.

*

*/

#include <e32def.h>

#include <e32err.h>

#include <w32std.h>

#include <gdi.h>

#include <gulutil.h>

#include <eiktxlbm.h>

// CColumnListBoxData API

#include <eikclbd.h>

#include <aknenv.h>

#include <aknconsts.h>

#include <avkon.mbg>

#include <aknPopup.h>

#include <AknLayoutDef.h>

#include <AknBidiTextUtils.h>

#include <gulcolor.h>

#include <skinlayout.cdl.h>

#include <AknLayoutFont.h>

#include <aknlayoutscalable_avkon.cdl.h> // LAF

#include <AknsDrawUtils.h>// skin

#include <AknsBasicBackgroundControlContext.h> //skin

#ifdef RD_JAVA_ADVANCED_TACTILE_FEEDBACK

#include <akntranseffect.h>

#include <akntransitionutils.h>

#endif //RD_JAVA_ADVANCED_TACTILE_FEEDBACK

// using MMIDBitmapImage API in NewElement and SetElement functions - setting icon to element

#include <lcdgr.h>

// macros definitions for resources

#include <lcdui.rsg>

#ifndef RD_SCALABLE_UI_V2

#include "CMIDForm.h"

#endif

// API used in HandlePointerEventL function

#include "CMIDDisplayable.h"

#include "CMIDFont.h"

// using CMIDUtils::CopyBitmapL in NewElement and SetElement functions - setting icon to element

#include "CMIDUtils.h"

#include "CMIDChoiceGroupControl.h"

// needed for CMIDChoiceGroupItem API in several places

#include "CMIDChoiceGroupItem.h"

// using SetTitleL in DoPopupL function - setting popup title

#include "CMIDItemLabel.h"

// using GetPopupNoteController in ShowInfoPopup function - showing popup with text

#include "CMIDPopupNoteController.h"

#include <j2me/jdebug.h>

// For disabling transition effects

#include <aknlistloadertfx.h>

#include <aknlistboxtfx.h>

/** This macro is executed each time a trapped call returns an error code different than KErrNone */

#undef  TRAP_INSTRUMENTATION_LEAVE

#define TRAP_INSTRUMENTATION_LEAVE(aResult) DEBUG_INT2("In CMIDChoiceGroupControl.cpp, trapped method was called at line %D and got exception %D", __LINE__, aResult);

// Constant used for calculation of ChoiceGroup, which is not in Form yet

// (from eiklbx.cpp)

const TInt KEikListBoxItemVGap = 6;

CMIDChoiceGroupPopupList* CMIDChoiceGroupPopupList::NewL(CEikListBox* aListBox, TInt aCbaResource,

        AknPopupLayouts::TAknPopupLayouts aType)

{

    CMIDChoiceGroupPopupList* self = new(ELeave) CMIDChoiceGroupPopupList;

    CleanupStack::PushL(self);

    self->ConstructL(aListBox, aCbaResource, aType);

    CleanupStack::Pop(self);

    return self;

}

CMIDChoiceGroupPopupList::~CMIDChoiceGroupPopupList()

{

}

void CMIDChoiceGroupPopupList::ResizeList()

{

    CAknPopupList::SetupWindowLayout(AknPopupLayouts::EMenuUnknownColumnWindow);

}

#ifdef RD_SCALABLE_UI_V2

void CMIDChoiceGroupPopupList::HandlePointerEventL(const TPointerEvent& aPointerEvent)

{

    if (aPointerEvent.iType == TPointerEvent::EButton1Down &&

            !Rect().Contains(aPointerEvent.iPosition))

    {

        AttemptExitL(EFalse);

    }

    else

    {

        CAknPopupList::HandlePointerEventL(aPointerEvent);

    }

}

#endif //RD_SCALABLE_UI_V2

CMIDChoiceGroupPopupList::CMIDChoiceGroupPopupList()

{

}

CMIDChoiceGroupControl::CMIDChoiceGroupControl(

    MMIDChoiceGroup::TChoiceType aType,

    CMIDChoiceGroupItem* aItem)

        : iType(aType),

        iItem(aItem)

{

}

CMIDChoiceGroupControl::~CMIDChoiceGroupControl()

{

    // Do not allow the listbox data to delete the icon

    // array. It will be deleted by the model.

    DeleteListBox(iListBox);

    // No need to delete iPopupList here. The popup list is created and deleted in DoPopupL().

    delete iModel;

}

// Constructs the model and adds any given elements into it.

// NOTE that the actual control is not yet created, it comes

// to life when the item is added to a form (that has a window

// for the control to draw in). Constructing and storing the model

// outside the actual control enables elements to be manipulated

// (in Java code) even when the ChoiceGroup is not (yet) added to a form.

void CMIDChoiceGroupControl::ConstructL(

    RArray<TPtrC>& aStringArray,

    RArray<MMIDImage*>& aImageArray)

{

    // Create the listbox model

    iModel = new(ELeave) CMIDChoiceGroupModel(iType);

    iModel->ConstructL(iEikonEnv);

    // Start observing model events

    iModel->SetObserver(this);

    // Stuff any given arrays in the model

    PopulateModelL(aStringArray, aImageArray);

    UpdateMargins();

    SetComponentsToInheritVisibility(ETrue);

#ifdef RD_SCALABLE_UI_V2

    SetAllowStrayPointers();

#endif

#ifdef RD_TACTILE_FEEDBACK

    iFeedback = MTouchFeedback::Instance();

    // Disabling default tactile feedback to prevent a 'double feedback' while tapping on focused item

    iFeedback->EnableFeedbackForControl(this, FALSE);

#endif

}

// Creates the actual choicegroup control, sets all kinds of

// properties and associates the model with the created control

void CMIDChoiceGroupControl::CreateControlL(

    const CCoeControl* aParent,

    const TRect& aRect)

{

    // Model should be created before the control (this is true for

    // popup as well)

    ASSERT(iModel);

    // In dynamic resolution case store the current item index, so that it can be

    // restored once the listbox is recreated

    TInt currentItem = KErrNotFound;

    if (iListBox)

    {

        currentItem = iListBox->View()->CurrentItemIndex();

    }

    DeleteControl();

    ASSERT(!iListBox);

    // Set parent to the existing (form) window and use the rect given

    SetContainerWindowL(*aParent);

    SetRect(aRect);

    UpdateMargins();

    // If this is a popup, there's nothing to else create really

    if (IsPopup())

    {

        return;

    }

    //in case skin or resolution has changed

    iModel->ReConstructSelectionIconsL();

    iModel->UpdateIconArrayL();

    iListBox = CreateListBoxL(aParent);

    // Disable transition effects for iListBox, this is needed to get

    // rid of artifacts caused by transition effects when list box controls

    // are scrolled up/down.

    CWindowGc* gc = iListBox->View()->ItemDrawer()->Gc();

    MAknListBoxTfx* transApi = CAknListLoader::TfxApi(gc);

    if (transApi)

    {

        transApi->EnableEffects(EFalse);

    }

    // setup listbox

    iListBox->SetListBoxObserver(this);

    iListBox->SetRect(ListBoxRect(Rect()));

    if (currentItem != KErrNotFound)

    {

        iListBox->View()->SetCurrentItemIndex(currentItem);

    }

    // Ready to draw

    ActivateL();

}

// Deletes the actual listbox control (when item is removed from a form)

// and disassociates the model from the control.

// Maintains the model so that elements can be accessed even

// if the item is not attached to a form

void CMIDChoiceGroupControl::DeleteControl()

{

    ClosePopup();

    // Gets rid of the listbox when choicegroup is removed from

    // a form, but does not yet kill the model (ie elements that

    // may have been added)

    DeleteListBox(iListBox);

    // Set to null, otherwise destructor will double-delete

    iListBox = NULL;

}

void CMIDChoiceGroupControl::HiliteFirstElement(TBool aEnableHighlight)

{

    if (iListBox)

    {

        iListBox->View()->SetCurrentItemIndex(0);

        EnableListHighlight(aEnableHighlight);

    }

}

void CMIDChoiceGroupControl::HiliteLastElement(TBool aEnableHighlight)

{

    if (iListBox)

    {

        iListBox->View()->SetCurrentItemIndex(iListBox->View()->BottomItemIndex());

        EnableListHighlight(aEnableHighlight);

    }

}

void CMIDChoiceGroupControl::EnableListHighlight(TBool aEnable)

{

    if (iListBox)

    {

        CListItemDrawer* drawer = iListBox->View()->ItemDrawer();

        if (aEnable)

        {

            drawer->ClearFlags(CListItemDrawer::EDisableHighlight);

        }

        else

        {

            drawer->SetFlags(CListItemDrawer::EDisableHighlight);

#ifdef RD_SCALABLE_UI_V2

            // If the focus is dragged to another form item, the highlight is

            // disabled in this cg. Set the flag to true to be sure that selection is not

            // changed if the pointer up happens on same cg element where the drag started.

            iPointerDragHasStarted = ETrue;

#endif

        }

        TRAP_IGNORE(iListBox->View()->UpdateSelectionL(CListBoxView::ESingleSelection));

    }

}

#ifdef RD_JAVA_S60_RELEASE_9_2

/**

 * Fuction sets ESingleClickDisabledHighlight - item drawer flags

 * and reports current highlight element change event

 */

void CMIDChoiceGroupControl::SingleClickDisableHighlightL(TBool aDisable)

{

    // Highlight should be disabled when listbox element taped

    if (iListBox)

    {

        iListBox->SingleClickDisableHighlightL(aDisable);

    }

}

#endif

// msk

void CMIDChoiceGroupControl::CurrentItemChanged()

{

    if (iItem)

    {

        // delegate the information to the item; commands may need to be updated

        iItem->UpdateCommands();

    }

    // redraw

    DrawNow();

}

// msk

TBool CMIDChoiceGroupControl::IsCurrentItemSelected()

{

    if (iListBox)

    {

        return IsSelected(iListBox->View()->CurrentItemIndex());

    }

    return EFalse;

}

// msk

// Posts always the java event

void CMIDChoiceGroupControl::ToggleCurrentItemSelectionL()

{

    if (iListBox)

    {

        // SelectElementL must not be called if the unselection of the selected element is

        // attempted in exclusive choice group because it would cause the itemStateChanged event.

        if (iType != MMIDChoiceGroup::EExclusive || !IsCurrentItemSelected())

        {

#ifdef RD_JAVA_S60_RELEASE_9_2

            if (Form() && !Form()->PhysicsScrolling())

            {

#endif // RD_JAVA_S60_RELEASE_9_2             

                TInt currentIndex = iListBox->View()->CurrentItemIndex();

                SelectElementL(currentIndex, !IsSelected(currentIndex), ETrue);

#ifdef RD_JAVA_S60_RELEASE_9_2

            }

#endif // RD_JAVA_S60_RELEASE_9_2

        }

    }

}

// returns the numbers of elements in this choice group

TInt CMIDChoiceGroupControl::NumberOfElements() const

{

    ASSERT(iModel);

    return iModel->NumberOfItems();

}

// --- CMIDChoiceGroupItem delegated methods (java Choice interface)

// Inserts a new element in the choice

void CMIDChoiceGroupControl::InsertElementL(TInt aIndex, const TDesC& aText, MMIDImage* aImage)

{

    ASSERT(iModel);

    CMIDChoiceGroupElement* pElement = NewElementLC(aText, aImage);

    // Reserve space for the new element

    iModel->SetReserveL(iModel->NumberOfItems() + 1);

    // Stuff it in

    iModel->InsertElementL(aIndex, pElement);

    CListBoxView* view = NULL;

    if (iListBox)

    {

        view = iListBox->View();

    }

    else if (iPopupList)

    {

        view = iPopupList->ListBox()->View();

    }

    if (view)

    {

        TInt current = view->CurrentItemIndex();

        if (current >= aIndex && current < (iModel->NumberOfItems() - 1))

        {

            // If element was inserted before the highlighted element,

            // move the highlight so that it stays in the same element

            // as before insertion.

            view->SetCurrentItemIndex(++current);

        }

    }

    CleanupStack::Pop(pElement);

}

// Deletes an element from the choice

void CMIDChoiceGroupControl::DeleteElementL(TInt aIndex)

{

    ASSERT(iModel);

    TInt current = 0;

    if (iListBox)

    {

        current = iListBox->View()->CurrentItemIndex();

    }

    iModel->DeleteElementL(aIndex);

    if (iListBox && current != KErrNotFound &&

            iModel->NumberOfItems() > 0 &&

            aIndex <= current)

    {

        if (current < iModel->NumberOfItems())

        {

            if (current > 0 && aIndex < current)

            {

                // Element was deleted before the current item, decrease

                // current so that highlight stays in the same element

                // as before the deletion

                --current;

            }

            iListBox->SetCurrentItemIndex(current);

        }

        else

        {

            iListBox->SetCurrentItemIndex(iModel->NumberOfItems()-1);

        }

    }

}

// Deletes all elements

void CMIDChoiceGroupControl::DeleteAllL()

{

    ASSERT(iModel);

    if (iListBox)

    {

        iListBox->SetCurrentItemIndex(0);

    }

    iModel->DeleteAllL();

}

// Sets properties of element at <aIndex>

void CMIDChoiceGroupControl::SetElementL(TInt aIndex, const TDesC& aText, MMIDImage* aImage)

{

    ASSERT(iModel);

    if (aImage)

    {

        MMIDBitmapImage* bitmapImage = aImage->BitmapImage();

        CFbsBitmap* bitmap = CMIDUtils::CopyBitmapL(bitmapImage->ColorBitmap());

        CleanupStack::PushL(bitmap);

        CFbsBitmap* mask = NULL;

        if (bitmapImage->AlphaBitmap())

        {

            TDisplayMode alphaDisplayMode = bitmapImage->AlphaBitmap()->DisplayMode();

            TBool invert = alphaDisplayMode == EGray2 ? ETrue : EFalse;

            mask = bitmapImage->CreateAlphaBitmapL(alphaDisplayMode, invert);

        }

        CleanupStack::PushL(mask);

        iModel->SetElementL(aIndex, aText, bitmap, mask);

        CleanupStack::Pop(mask);

        CleanupStack::Pop(bitmap);

        bitmapImage->RemoveRef();

    }

    else

    {

        iModel->SetElementL(aIndex, aText, NULL, NULL);

    }

}

// Sets selection state of element at <aIndex>

// This method is also declared in MMIDChoiceGroup. It's implementation

// in CMIDChoiceGroupItem just simply calls this method.

void CMIDChoiceGroupControl::SelectElementL(TInt aIndex, TBool aSelected)

{

    SelectElementL(aIndex, aSelected, EFalse);

}

// Returns selection state of element at <aIndex>

TBool CMIDChoiceGroupControl::IsSelected(TInt aIndex)

{

    ASSERT(iModel);

    CMIDChoiceGroupElement* pElement = iModel->ElementAt(aIndex);

    if (pElement)

    {

        return pElement->IsSelected();

    }

    return EFalse;

}