/*

* Copyright (c) 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: This file implements classes CNcsPopupListBox, CNcsListItemDrawer. 

*

*/

// INCLUDE FILES

#include "emailtrace.h"

#include <eikclbd.h>

#include <AknsFrameBackgroundControlContext.h>

#include <FreestyleEmailUi.rsg>						// R_FSE_EDITOR_ADDRESS_LIST_REMOTE_LOOKUP_SEARCH

#include <StringLoader.h>						// StringLoader

#include <CPbkContactEngine.h>

#include <AknsDrawUtils.h>

#include <AknsUtils.h>

#include <aknlayoutscalable_apps.cdl.h>

#include <aknlayoutscalable_avkon.cdl.h>

#include "ncspopuplistbox.h"

#include "ncsemailaddressobject.h"					// CNcsEmailAddressObject

#include "ncsconstants.h"

#include "ncsheadercontainer.h"						// CNcsHeaderContainer

#include "FreestyleEmailUiContactHandler.h"		// CFSEmailUiClsListsHandler

#include "ncsutility.h"

#include "FreestyleEmailUiUtilities.h"

#include "FreestyleEmailUiAppui.h"

#include "FreestyleEmailUiLayoutHandler.h"

#include "FSDelayedLoader.h"

#include "FreestyleEmailUiCLSItem.h"

const TInt KHighlightFrameWidth = 2;

// ========================= MEMBER FUNCTIONS ==================================

// -----------------------------------------------------------------------------

// CNcsPopupListBox::NewL

// -----------------------------------------------------------------------------

CNcsPopupListBox* CNcsPopupListBox::NewL( const CCoeControl* aParent, 

                                          CFSMailBox& aMailBox, 

                                          CNcsHeaderContainer& aHeaderContainer, 

                                          TBool aRemoteLookupSupported  )

    {

    FUNC_LOG;

    CNcsPopupListBox* self =  new (ELeave) CNcsPopupListBox( aHeaderContainer,

        aRemoteLookupSupported, aMailBox );

    CleanupStack::PushL( self );

    self->ConstructL( aParent );

    CleanupStack::Pop( self );

    return self;

    }

// -----------------------------------------------------------------------------

// CNcsPopupListBox::CNcsPopupListBox

// -----------------------------------------------------------------------------

CNcsPopupListBox::CNcsPopupListBox( CNcsHeaderContainer& aHeaderContainer, 

                                    TBool aRemoteLookupSupported, 

                                    CFSMailBox& aMailBox)

    : iHeaderContainer( aHeaderContainer ),

      iMailBox( aMailBox ),

      iRemoteLookupSupported( aRemoteLookupSupported ),

      iCachingInProgress( EFalse ),

      iAppUi( static_cast<CFreestyleEmailUiAppUi*>( iEikonEnv->AppUi() ) )

    {

    FUNC_LOG;

    iPopupMaxRect = TRect( 100, 100, 100, 100 );

    }

// -----------------------------------------------------------------------------

// CNcsPopupListBox::ConstructL

// -----------------------------------------------------------------------------

void CNcsPopupListBox::ConstructL( const CCoeControl* aParent )

    {

    FUNC_LOG;

    CEikTextListBox::ConstructL( NULL, CEikListBox::EPopout );

    SetMopParent( const_cast<CCoeControl*>( aParent ) );

    User::LeaveIfError( SetParent( const_cast<CCoeControl*>( aParent ) ) );

    CEikScrollBarFrame* frame = CreateScrollBarFrameL( EFalse, EFalse, ETrue );

    CEikTextListBox::SetBorder( TGulBorder::ENone );

    const CFont* font = AknLayoutUtils::FontFromId( EAknLogicalFontPrimarySmallFont );

    CEikTextListBox::SetItemHeightL( font->FontMaxHeight() + 12 );

    iBackgroundContext = CAknsFrameBackgroundControlContext::NewL(

        KAknsIIDQsnFrPopupSub, Rect(), Rect(), EFalse );

    UpdateTextColors();

    iContactHandler = CFsDelayedLoader::InstanceL()->GetContactHandlerL();

    if ( !iContactHandler->IsLanguageSupportedL() )

        {

        iContactHandler = NULL;

        }

    SetListBoxObserver( this );

    }

// -----------------------------------------------------------------------------

// CNcsPopupListBox::InitAndSearchL

// -----------------------------------------------------------------------------

void CNcsPopupListBox::InitAndSearchL( const TDesC& aText, TInt aMode )

    {

    FUNC_LOG;

    SetSearchTextL( aText, aMode );

    RPointerArray<CFSEmailUiClsItem> emptyArray;

    CleanupClosePushL( emptyArray );

    OperationCompleteL( ESearchContacts, emptyArray );

    CleanupStack::PopAndDestroy( &emptyArray );

    }

// ---------------------------------------------------------------------------

// CNcsPopupListBox::~CNcsPopupListBox

// ---------------------------------------------------------------------------

CNcsPopupListBox::~CNcsPopupListBox()

    {

    FUNC_LOG;

    delete iBackgroundContext;

    delete iItemTextsArray;

    delete iCurrentSearchText;

    iMatchingItems.ResetAndDestroy();

    }

// -----------------------------------------------------------------------------

// CNcsPopupListBox::CreateItemDrawerL

// -----------------------------------------------------------------------------

void CNcsPopupListBox::CreateItemDrawerL()

    {

    FUNC_LOG;

    iItemDrawer = new (ELeave) CNcsListItemDrawer( *this );

    }

// -----------------------------------------------------------------------------

// CNcsPopupListBox::MopSupplyObject

// -----------------------------------------------------------------------------

TTypeUid::Ptr CNcsPopupListBox::MopSupplyObject(TTypeUid aId)

    {

    FUNC_LOG;

    if ( aId.iUid == MAknsControlContext::ETypeId )

        {

        return MAknsControlContext::SupplyMopObject( aId, iBackgroundContext );

        }

    return CCoeControl::MopSupplyObject( aId );

    }

// -----------------------------------------------------------------------------

// CNcsPopupListBox::SizeChanged

// -----------------------------------------------------------------------------

void CNcsPopupListBox::SizeChanged()

    {

    FUNC_LOG;

    const TRect outerRect = Rect();

    TAknLayoutRect subpane;

    subpane.LayoutRect( outerRect, 

        AknLayoutScalable_Avkon::bg_popup_sub_pane_g1() );

    const TRect innerRect = subpane.Rect();

    iBackgroundContext->SetFrameRects( outerRect, innerRect );

    SetViewRectFromClientRect( innerRect );

    TRAP_IGNORE( HandleViewRectSizeChangeL() );

    }

void CNcsPopupListBox::HandleResourceChange( TInt aType )

    {

    FUNC_LOG;

    if ( aType == KAknsMessageSkinChange )

        {

        UpdateTextColors();

        }

    }

void CNcsPopupListBox::HandlePointerEventL( const TPointerEvent& aPointerEvent )

    {

    CEikTextListBox::HandlePointerEventL( aPointerEvent );

    }

// -----------------------------------------------------------------------------

// CNcsPopupListBox::OfferKeyEventL

// -----------------------------------------------------------------------------

//    

TKeyResponse CNcsPopupListBox::OfferKeyEventL( const TKeyEvent& aKeyEvent,

    TEventCode aType )

    {

    FUNC_LOG;

    TKeyResponse ret( EKeyWasNotConsumed );

    if( aKeyEvent.iCode == EKeyDownArrow )

        {

        MoveRemoteLookupItemL( ERemoteLookupItemDown );

        iView->MoveCursorL( CListBoxView::ECursorNextItem, CListBoxView::ENoSelection );

		ret = EKeyWasConsumed;

        } 

    else if( aKeyEvent.iCode == EKeyUpArrow )

        {

		TBool stay = EFalse;

        // Move cursor separator line over

		if ( CurrentItemIndex() - 1 > 0 && CurrentItemIndex() - 1 == iRemoteLookupItemPos )

			{

	        MoveRemoteLookupItemL( ERemoteLookupItemUp );

	        iView->MoveCursorL( CListBoxView::ECursorPreviousItem, CListBoxView::ENoSelection );

			stay = ETrue;

			}

        MoveRemoteLookupItemL( ERemoteLookupItemUp );

        iView->MoveCursorL( CListBoxView::ECursorPreviousItem, CListBoxView::ENoSelection );

	    if( stay )

			{

	        MoveRemoteLookupItemL( ERemoteLookupItemDown );

			iView->MoveCursorL( CListBoxView::ECursorNextItem, CListBoxView::ENoSelection );

			}

    	ret = EKeyWasConsumed;

        }

    if( ret == EKeyWasNotConsumed )

        {

        ret = CEikListBox::OfferKeyEventL( aKeyEvent, aType );

        }

	// call HandleItemAdditionL just in case. There might be changes on remote lookup item place.

	// The call is here, because we don't want to have extra redraw events when the popuplist

	// is not fully updated.

	HandleItemAdditionL(); 

    return ret;

    }

// ---------------------------------------------------------------------------

// CNcsPopupListBox::HandleListBoxEventL

// ---------------------------------------------------------------------------

//      

void CNcsPopupListBox::HandleListBoxEventL( CEikListBox* /*aListBox*/,

    TListBoxEvent aEventType )

    {

    if ( aEventType == EEventItemClicked || 

         aEventType == EEventItemSingleClicked )

        {

        iHeaderContainer.DoPopupSelectL();

        }

    }

// -----------------------------------------------------------------------------

// CNcsPopupListBox::OperationComplete

// -----------------------------------------------------------------------------

//

void CNcsPopupListBox::OperationCompleteL( TContactHandlerCmd /*aCmd*/,

    const RPointerArray<CFSEmailUiClsItem>& aMatchingItems )

    {

    FUNC_LOG;

    iMatchingItems.ResetAndDestroy();

    // Replace old matcing items.

    for ( TInt ii = 0; ii < aMatchingItems.Count(); ++ii )

    	{

    	if ( aMatchingItems[ii] )

    		{

    		CFSEmailUiClsItem* item = aMatchingItems[ii]->CloneLC();  		

    		iMatchingItems.AppendL( item );

    		CleanupStack::Pop( item );

    		}

    	}

    UpdateListL();

    }

void CNcsPopupListBox::OperationErrorL( TContactHandlerCmd aCmd, TInt aError )

	{

    FUNC_LOG;

	if ( aCmd == ESearchContacts )

		{

		// KerrNotReady --> caching in progress, KErrNotFound --> caching not started yet

		if ( (aError == KErrNotReady) || (aError == KErrNotFound) )

			{

			if(!iAppUi->AppUiExitOngoing()) //<cmail>

			    TFsEmailUiUtility::ShowInfoNoteL( R_FSE_EDITOR_INFO_BUILDING_CACHE );

			iCachingInProgress = ETrue;

			}

		if ( aError == KErrNone && iCachingInProgress )

			{

			if(!iAppUi->AppUiExitOngoing()) //<cmail>

			    TFsEmailUiUtility::ShowInfoNoteL( R_FSE_EDITOR_INFO_CACHING_COMPLETED );

			iCachingInProgress = EFalse;

			}

		}

	}

// -----------------------------------------------------------------------------

// CNcsPopupListBox::SetSearchTextL

// -----------------------------------------------------------------------------

//

void CNcsPopupListBox::SetSearchTextL( const TDesC& aText, TInt aMode )

    {

    FUNC_LOG;

    delete iCurrentSearchText;

    iCurrentSearchText = NULL;

    iCurrentSearchText = aText.AllocL();

    if ( !iCachingInProgress  )

        {

        if ( iContactHandler  )

            {

            iContactHandler->SearchMatchesL( aText, this, &iMailBox, aMode );

            }

        }

    }

// -----------------------------------------------------------------------------

// CNcsPopupListBox::ReturnCurrentEmailAddressLC

// -----------------------------------------------------------------------------

//

CNcsEmailAddressObject* CNcsPopupListBox::ReturnCurrentEmailAddressLC()

    {

    FUNC_LOG;

    CNcsEmailAddressObject* addressObject = NULL;

    if ( iMatchingItems.Count() )

        {

        CFSEmailUiClsItem* clsItem = NULL;

        if ( iRemoteLookupSupported )

            {

            // calculate index of item

            TInt index = (CurrentItemIndex() > iRemoteLookupItemPos ? CurrentItemIndex() - 1 : CurrentItemIndex());

            clsItem = iMatchingItems[index];

            }

        else

            {

            clsItem = iMatchingItems[CurrentItemIndex()]; // no iRemoteLookupItemPos

            }

        addressObject= CNcsEmailAddressObject::NewL( clsItem->DisplayName(), clsItem->EmailAddress() );

        CleanupStack::PushL( addressObject );

        if ( clsItem->MultipleEmails() )

            {

            addressObject->SetDisplayFull( ETrue );

            }

        }

    return addressObject;

    }

// -----------------------------------------------------------------------------

// CNcsPopupListBox::SetPopupMaxRect

// -----------------------------------------------------------------------------

void CNcsPopupListBox::SetPopupMaxRect( const TRect& aPopupMaxRect )

    {

    FUNC_LOG;

    iPopupMaxRect = aPopupMaxRect;

    SetPopupRect();

    TRAP_IGNORE( UpdateScrollBarsL() );

    TRAP_IGNORE( SetScrollBarVisibilityL() );

    }

// -----------------------------------------------------------------------------

// CNcsPopupListBox::IsPopupEmpty

// -----------------------------------------------------------------------------

TBool CNcsPopupListBox::IsPopupEmpty() const

    {

    FUNC_LOG;

    if ( Model()->NumberOfItems() > 0 )

        return EFalse;

    else

        return ETrue;

    }

// -----------------------------------------------------------------------------

// CNcsPopupListBox::IsRemoteLookupItemSelected

// -----------------------------------------------------------------------------

TBool CNcsPopupListBox::IsRemoteLookupItemSelected() const

    {

    FUNC_LOG;

    if ( CurrentItemIndex() == iRemoteLookupItemPos && iRemoteLookupSupported )

        return ETrue;

    else

        return EFalse;

    }

// -----------------------------------------------------------------------------

// CNcsPopupListBox::CurrentPopupClsItemsArray

// -----------------------------------------------------------------------------

const RPointerArray<CFSEmailUiClsItem>& CNcsPopupListBox::CurrentPopupClsItemsArray() const

    {

    return iMatchingItems;

    }

// -----------------------------------------------------------------------------

// CNcsPopupListBox::RemoteLookupItemPos

// -----------------------------------------------------------------------------

TInt CNcsPopupListBox::RemoteLookupItemPos() const

    {

    FUNC_LOG;

    return iRemoteLookupItemPos;

    }

// -----------------------------------------------------------------------------

// CNcsPopupListBox::LayoutHandler

// -----------------------------------------------------------------------------

CFSEmailUiLayoutHandler& CNcsPopupListBox::LayoutHandler() const

    {

    FUNC_LOG;

    return *iAppUi->LayoutHandler();

    }

// -----------------------------------------------------------------------------

// CNcsPopupListBox::SetListItemsFromArrayL

// -----------------------------------------------------------------------------

void CNcsPopupListBox::SetListItemsFromArrayL()

	{

    FUNC_LOG;

	// reset the cursor to point to the first item

    //iView->MoveCursorL( CListBoxView::ECursorFirstItem, CListBoxView::ENoSelection);

	Reset();

	// Create totally new text array

	CreateTextArrayAndSetToTheListboxL( ETrue );

	// append texts to text array

	for( TInt i=0; i < iMatchingItems.Count(); i++ )

		{

		iItemTextsArray->AppendL( iMatchingItems[i]->FullTextL() );

		}

	// Update rmlu item

	SetRemoteLookupItemFirstToTheListL();

	SetPopupRect();

	SetScrollBarVisibilityL();

	HandleItemAdditionL();

    if ( iItemTextsArray && iItemTextsArray->Count() > 0 )

        {

        SetCurrentItemIndex( 0 );

        }

    if ( IsVisible() )

        {

        DrawDeferred();

        }

    }

// -----------------------------------------------------------------------------

// CNcsPopupListBox::RoundToItemHeight

// -----------------------------------------------------------------------------

TInt CNcsPopupListBox::RoundToItemHeight(const TInt aPopupHeight) const

    {

    TReal fullItems; // number of full visible items in window

    TInt err = Math::Round(fullItems, (aPopupHeight / ItemHeight()), 0);

    if (err == KErrNone)

        {

        return (TInt)(fullItems * ItemHeight()); 

        }

    return aPopupHeight; // in case of error

    }

// -----------------------------------------------------------------------------

// CNcsPopupListBox::SetPopupRect

// -----------------------------------------------------------------------------

void CNcsPopupListBox::SetPopupRect()

    {

    FUNC_LOG;

    // The popup width and horizontal position is adjusted so that it

    // will be within the area specified in both layout data and the set

    // maximum rect.

    TAknLayoutRect editorPane;

    editorPane.LayoutRect( iAppUi->ClientRect(),

        TAknWindowComponentLayout::Compose(

            TAknWindowComponentLayout::Compose(

                AknLayoutScalable_Apps::list_cmail_pane(),

                AknLayoutScalable_Apps::list_single_cmail_header_detail_pane( 0 ) ),

            AknLayoutScalable_Apps::list_single_cmail_header_editor_pane_bg( 4 ) ) );

    TRect editorPaneRect = editorPane.Rect();

    TRect newRect = iPopupMaxRect;

    newRect.iTl.iX = Max( iPopupMaxRect.iTl.iX, editorPaneRect.iTl.iX );

    newRect.iBr.iX = Min( iPopupMaxRect.iBr.iX, editorPaneRect.iBr.iX );

    // Thhe popup height and vertical position is adjusted based on the

    // available space below and above the cursor and the number of items

    // in the list.

    const TRect rect = iPopupMaxRect;

    TAknLayoutRect subpane;

    subpane.LayoutRect( rect, AknLayoutScalable_Avkon::bg_popup_sub_pane_g1() );

    const TRect subpaneRect = subpane.Rect();

    const TInt frameHeights = iPopupMaxRect.Height() - subpaneRect.Height();

    // This is the total height in pixels needed to show all items

    TInt minimumHeight = frameHeights + 

        CalcHeightBasedOnNumOfItems( Model()->NumberOfItems() );

    CCoeControl* container = Parent()->Parent();

    TInt containerTop = container->PositionRelativeToScreen().iY;

    TInt containerHeight = container->Rect().Height();

    TInt containerCenter = containerTop + containerHeight / 2;

    // Get height of one line in Address field

    CNcsHeaderContainer* headerObj = static_cast<CNcsHeaderContainer* >(Parent());

    TInt toLineHeight = headerObj->GetToLineHeight(); // height of one line height

    if ( toLineHeight == 0 )

        {

        toLineHeight = ItemHeight();

        }

    TInt newHeight = minimumHeight; // default window height

    // latch listbox on the bottom of the editor field

    if ( newRect.iTl.iY <= containerCenter ) 

        {

        TInt maxHeight = containerHeight - ( newRect.iTl.iY - containerTop ); 

        newHeight = RoundToItemHeight( maxHeight - frameHeights ) + frameHeights;

        if ( newHeight > minimumHeight )

            {

            newHeight = minimumHeight; // shrink window (if needed)

            }

        }

    // latch listbox on the top of the editor field