/*

* Copyright (c) 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:  Implementation of common container for AVKON platform.

*

*/

// INCLUDE FILES

#include <barsread.h>

#include <stringloader.h>

#include <akniconarray.h>

#include <gulicon.h>

#include <featmgr.h>

#include <aknsfld.h>

#include <aknutils.h>

#include <aknlists.h>

#include <aknconsts.h>

#include <avkon.mbg>

#include <eikclbd.h>

#include <eikcmobs.h>

#include <bautils.h>

#include <data_caging_path_literals.hrh>

#include <mpxcommoncontainer.rsg>

#include <mpxlog.h>

#include <mpxuser.h>

#include "mpxcommonlistboxarraybase.h"

#include "mpxcommoncontaineravkonimp.h"

#include "mpxcommoncontainer.hrh"

#include <mpxlbxextendedfeatures.h>

// CONSTANTS

const TInt KMPXFindboxTextLimit = 40;

_LIT( KMPXCommonContainerRscPath, "mpxcommoncontainer.rsc" );

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

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

// C++ constructor can NOT contain any code that might leave.

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

//

CMPXCommonContainerAvkonImp::CMPXCommonContainerAvkonImp() :

    iIsFindEnabled( ETrue ),

    iIsMarkingEnabled( ETrue ),

    iContainerActive( EFalse )

    {

    }

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

// Destructor

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

//

CMPXCommonContainerAvkonImp::~CMPXCommonContainerAvkonImp()

    {

    MPX_FUNC( "CMPXCommonContainerAvkonImp::~CMPXCommonContainerAvkonImp" );    

    FeatureManager::UnInitializeLib();        

    if ( iResourceOffset )

        {

        iEikonEnv->DeleteResourceFile( iResourceOffset );

        }

    delete iListBox;

    delete iFindBox;

    delete iLbxExtFeat;

    }

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

// Return Coe Control

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

//

CCoeControl* CMPXCommonContainerAvkonImp::CoeControl()

    {

    MPX_FUNC( "CMPXCommonContainerAvkonImp::CoeControl" );

    return this;

    }

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

// Set View Container

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

//

void CMPXCommonContainerAvkonImp::SetViewContainer(

    MMPXViewContainer* aViewContainer )

    {

    MPX_FUNC( "CMPXCommonContainerAvkonImp::SetViewContainer" );

    iViewContainer = aViewContainer;

    }

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

// Set command observer for the container

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

//

void CMPXCommonContainerAvkonImp::SetCommandObserver(    

    MEikCommandObserver* aCommandObserver )

    {

    MPX_FUNC( "CMPXCommonContainerAvkonImp::SetCommandObserver" );

    iView = aCommandObserver;

    }

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

// C++ constructor can NOT contain any code that might leave.

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

//

void CMPXCommonContainerAvkonImp::SetListBoxObserver(

    MEikListBoxObserver* aListBoxObserver )

    {

    MPX_FUNC( "CMPXCommonContainerAvkonImp::SetListBoxObserver" );

    iListBoxObserver = aListBoxObserver;

    }

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

// Set layout for all elements and set sizes for icons.

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

//

void CMPXCommonContainerAvkonImp::UpdateLayout()

    {        

    MPX_FUNC( "CMPXCommonContainerAvkonImp::UpdateLayout" );

    }

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

// Returns a pointer to the listboxarray

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

//

CMPXCommonListBoxArrayBase* CMPXCommonContainerAvkonImp::ListBoxArray() const

    {

    ASSERT( iListBoxArray );

    return iListBoxArray;

    }

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

// Sets listbox array

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

//

void CMPXCommonContainerAvkonImp::SetListBoxArrayL(

    CMPXCommonListBoxArrayBase* aListBoxArray )

    {

    iListBoxArray = aListBoxArray;

    if ( iListBoxArray )

        {

        CTextListBoxModel* listboxModel = iListBox->Model();

        listboxModel->SetItemTextArray( iListBoxArray );

        listboxModel->SetOwnershipType( ELbmOwnsItemArray );

        }

    }

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

// Return number of listbox items shown in the current listbox.

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

//

TInt CMPXCommonContainerAvkonImp::CurrentListItemCount() const

    {

    MPX_FUNC( "CMPXCommonContainerAvkonImp::CurrentListItemCount" );

    ASSERT( iFindBoxFilterItems );

    return iFindBoxFilterItems->FilteredNumberOfItems();

    }

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

// Return total number of listbox items in the listbox.

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

//

TInt CMPXCommonContainerAvkonImp::TotalListItemCount() const

    {

    MPX_FUNC( "CMPXCommonContainerAvkonImp::TotalListItemCount" );

    ASSERT( iFindBoxFilterItems );

    return iFindBoxFilterItems->NonFilteredNumberOfItems();

    }

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

// Gets top listbox item index (relative to the original listbox).

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

//

TInt CMPXCommonContainerAvkonImp::TopLbxItemIndex() const

    {

    MPX_FUNC( "CMPXCommonContainerAvkonImp::TopLbxItemIndex" );

    ASSERT( iListBox );

    ASSERT( iFindBoxFilterItems );

    TInt topItem( iListBox->TopItemIndex() );

    // Make sure there's at least one item in the listbox

    if ( iFindBoxFilterItems->FilteredNumberOfItems() )

        {

        // Get the real listbox index

        topItem = iFindBoxFilterItems->FilteredItemIndex( topItem );

        }

    return topItem;

    }

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

// Gets bottom listbox item index (relative to the original listbox).

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

//

TInt CMPXCommonContainerAvkonImp::BottomLbxItemIndex() const

    {

    MPX_FUNC( "CMPXCommonContainerAvkonImp::BottomLbxItemIndex" );

    ASSERT( iListBox );

    ASSERT( iFindBoxFilterItems );

    TInt bottomItem( iListBox->BottomItemIndex() );

    // Make sure there's at least one item in the listbox

    if ( iFindBoxFilterItems->FilteredNumberOfItems() )

        {

        // Get the real listbox index

        bottomItem = iFindBoxFilterItems->FilteredItemIndex( bottomItem );

        }

    return bottomItem;

    }    

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

// Gets current listbox item index (relative to the original listbox).

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

//

TInt CMPXCommonContainerAvkonImp::CurrentLbxItemIndex() const

    {

    MPX_FUNC( "CMPXCommonContainerAvkonImp::CurrentLbxItemIndex" );    

    ASSERT( iListBox );

    ASSERT( iFindBoxFilterItems );

    TInt currentItem( iListBox->CurrentItemIndex() );

    // Make sure there's at least one item in the listbox

    if ( iFindBoxFilterItems->FilteredNumberOfItems() )

        {

        // Get the real listbox index

        currentItem = iFindBoxFilterItems->FilteredItemIndex( currentItem );

        }

    return currentItem;

    }

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

// Get current selected listbox items indices (relative to the original listbox)

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

//

const CArrayFix<TInt>* CMPXCommonContainerAvkonImp::

    CurrentSelectionIndicesL() const

    {

    MPX_FUNC( "CMPXCommonContainerAvkonImp::CurrentSelectionIndicesL" );

    ASSERT( iListBox );

    ASSERT( iFindBoxFilterItems );

    const CArrayFix<TInt>* selectionArray( iListBox->SelectionIndexes() );

    if ( iFindBoxFilterItems->FilteredNumberOfItems() )

        {

        // Get the real listbox indices

        iFindBoxFilterItems->SelectionIndexes()->Reset();

        iFindBoxFilterItems->UpdateSelectionIndexesL();

        selectionArray = iFindBoxFilterItems->SelectionIndexes();

        }

    return selectionArray;

    }

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

// Get current selected listbox items indices (relative to the original listbox)

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

//

void CMPXCommonContainerAvkonImp::SetCurrentSelectionIndicesL(

    CArrayFix<TInt>* aIndices ) const

    {

    MPX_FUNC( "CMPXCommonContainerAvkonImp::SetCurrentSelectionIndicesL" );    

    ASSERT( iListBox );

    iListBox->SetSelectionIndexesL( aIndices ); // ownership not transfered

    }

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

// Set top listbox item index.

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

//

void CMPXCommonContainerAvkonImp::SetLbxTopItemIndex( TInt aIndex )

    {

    MPX_FUNC( "CMPXCommonContainerAvkonImp::SetLbxTopItemIndex" );

    ASSERT( iListBox );

    ASSERT( iFindBoxFilterItems );

    TInt index( iFindBoxFilterItems->VisibleItemIndex( aIndex ) );

    if ( index == KErrNotFound )

        {

        index = 0;

        }

    iListBox->SetTopItemIndex( index );

    }

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

// Set current listbox item index.

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

//

void CMPXCommonContainerAvkonImp::SetLbxCurrentItemIndex( TInt aIndex )

    {

    MPX_FUNC( "CMPXCommonContainerAvkonImp::SetLbxCurrentItemIndex" );

    ASSERT( iListBox );

    ASSERT( iFindBoxFilterItems );

    TInt index( iFindBoxFilterItems->VisibleItemIndex( aIndex ) );

    if ( index == KErrNotFound )

        {

        index = 0;

        }

    iListBox->SetCurrentItemIndex( index );

    }

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

// Set current listbox item index and highlight it.

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

//

void CMPXCommonContainerAvkonImp::SetLbxCurrentItemIndexAndDraw( 

    TInt aIndex )

    {

    MPX_FUNC( "CMPXCommonContainerAvkonImp::SetLbxCurrentItemIndexAndDraw" );

    ASSERT( iListBox );

    ASSERT( iFindBoxFilterItems );

    TInt index( iFindBoxFilterItems->VisibleItemIndex( aIndex ) );

    if ( index == KErrNotFound )

        {

        index = 0;

        }

    iListBox->SetCurrentItemIndexAndDraw( index );

    }

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

// Clear listbox selection.

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

//

void CMPXCommonContainerAvkonImp::ClearLbxSelection()

    {

    MPX_FUNC( "CMPXCommonContainerAvkonImp::ClearLbxSelection" );

    ASSERT( iListBox );

    ASSERT( iFindBoxFilterItems );

    iListBox->ClearSelection();

    iFindBoxFilterItems->SelectionIndexes()->Reset();

    }

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

// Sets the text for an empty list box

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

//

void CMPXCommonContainerAvkonImp::SetLbxEmptyTextL( const TDesC& aText )

    {

    ASSERT( iListBox );

    iListBox->View()->SetListEmptyTextL( aText );

    }

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

// Draws a list box item

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

//

void CMPXCommonContainerAvkonImp::DrawLbxItem( TInt aIndex )

    {

    ASSERT( iListBox );

    TInt topIndex( TopLbxItemIndex() );

    TInt bottomIndex( BottomLbxItemIndex() );

    if ( aIndex >= topIndex && aIndex <= bottomIndex )

        {

        iListBox->DrawItem( aIndex );

        }

    }

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

// Set Find box's focus.

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

//

void CMPXCommonContainerAvkonImp::SetFindBoxFocus( TBool aFocus )

    {

    MPX_FUNC( "CMPXCommonContainerAvkonImp::SetFindBoxFocus" );

    ASSERT( iFindBox );

    if ( aFocus )

        {

        iFindBox->MakeVisible( ETrue );

        }

    iFindBox->SetFocus( aFocus );

    }

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

// Handle listbox item addition.

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

//

void CMPXCommonContainerAvkonImp::HandleLbxItemAdditionL()

    {

    MPX_FUNC( "CMPXCommonContainerAvkonImp::HandleLbxItemAdditionL" );

    ASSERT( iListBox );

    ASSERT( iFindBoxFilterItems );

    iFindBoxFilterItems->HandleItemArrayChangeL();

    iListBox->HandleItemAdditionL();

    }

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

// Handle listbox item addition, preserving the current display index

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

//

void CMPXCommonContainerAvkonImp::HandleLbxItemAdditionPreserveIndexL()

    {        

    MPX_FUNC( "CMPXCommonContainerAvkonImp::HandleLbxItemAdditionPreserveIndexL" );

    TInt currentItem( CurrentLbxItemIndex() );

    TInt currentBottomIndex( BottomLbxItemIndex() );

    TInt topIndex( CalculateTopIndex( currentBottomIndex ) );

    HandleLbxItemAdditionL();

    if ( currentItem > 0 )

        {

        // only redraw if the selected index is > 0, since 

        // HandleLbxItemAdditionL already redraws it and set index

        // to 0

        SetLbxTopItemIndex( topIndex );

        SetLbxCurrentItemIndexAndDraw( currentItem );

        }

    }

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

// Handle listbox item removal.

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

//

void CMPXCommonContainerAvkonImp::HandleLbxItemRemovalL()

    {

    MPX_FUNC( "CMPXCommonContainerAvkonImp::HandleLbxItemRemovalL" );

    ASSERT( iListBox );

    iListBox->HandleItemRemovalL();

    }

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

// Show/hide find box.

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

//

void CMPXCommonContainerAvkonImp::SetFindBoxVisibilityL( TBool aIsVisible )

    {

    MPX_FUNC( "CMPXCommonContainerAvkonImp::SetFindBoxVisibilityL" );

    ASSERT( iListBox );

    ASSERT( iFindBox );

    if (aIsVisible != iFindBox->IsVisible())

        {

        iFindBox->MakeVisible( aIsVisible );

        iFindBox->SetFocus( aIsVisible );

        if ( !aIsVisible )

            {

            iFindBox->ResetL();

            iFindBoxFilterItems->HandleOfferkeyEventL();

            iListBox->SetFocus( ETrue );

            }

        SizeChanged();

        DrawDeferred();

        }

    }

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

// Determine find box visibility

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

//

TBool CMPXCommonContainerAvkonImp::FindBoxVisibility()

    {

    MPX_FUNC( "CMPXCommonContainerAvkonImp::FindBoxVisibility" );

    ASSERT( iFindBox );

    return iFindBox->IsVisible();

    }

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

// Restore the PopupCBA of find box

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

//

void CMPXCommonContainerAvkonImp::RestoreFindBoxPopupCBA()

    {

    MPX_FUNC( "CMPXCommonContainerAvkonImp::RestoreFindBoxPopupCBA" );

    ASSERT( iFindBox );

    iFindBox->SetFocus( ETrue );

    iFindBox->SetFocus( EFalse );

    }

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

// Calculate the top index of the visible items

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

//    

TInt CMPXCommonContainerAvkonImp::CalculateTopIndex( TInt aBottomIndex )

    {

    MPX_FUNC( "CMPXCommonContainerAvkonImp::CalculateTopIndex" );

    ASSERT( iListBox );

    TInt numItems( iListBox->View()->NumberOfItemsThatFitInRect( 

        iListBox->View()->ViewRect() ) - 1 ); // to make it 0 based

    return ( ( aBottomIndex > numItems ) ? aBottomIndex - numItems : 0 );

    }

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

// Symbian 2nd phase constructor can leave.

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

//

void CMPXCommonContainerAvkonImp::ConstructContainerL( TMPXCommonContainerCollectionType /*aCollectionType*/ )

    {

    MPX_FUNC( "CMPXCommonContainerAvkonImp::ConstructContainerL" );    

    CCoeEnv* coeEnv( iEikonEnv );

    TParse parse;

    parse.Set( KMPXCommonContainerRscPath, &KDC_APP_RESOURCE_DIR, NULL );

    TFileName resourceFile( parse.FullName() );

    User::LeaveIfError( MPXUser::CompleteWithDllPath( resourceFile ) );

    BaflUtils::NearestLanguageFile( coeEnv->FsSession(), resourceFile );

    iResourceOffset = coeEnv->AddResourceFileL( resourceFile );    

    CreateWindowL();

    CreateListBoxL();

    FeatureManager::InitializeLibL();

    ConstructFindBoxL( ETrue );                

    }

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

// Enable/disable find box  

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

//

void CMPXCommonContainerAvkonImp::EnableFindBox( TBool aEnable )

    {

    MPX_FUNC( "CMPXCommonContainerAvkonImp::EnableFindBox" );    

    iIsFindEnabled = aEnable;

    if ( !aEnable )

        {

        TRAP_IGNORE(SetFindBoxVisibilityL( EFalse ));

        };

    }

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

// Enable/disable marking  

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