/*

* 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:  Visualiser class for Control Button component.

*

*/

#include "emailtrace.h"

#include <alf/alfcontrol.h>

#include <alf/alfdecklayout.h>

#include <alf/alfimagevisual.h>

#include <alf/alfgridlayout.h>

#include <alf/alfenv.h>

#include <alf/alftextstylemanager.h>

#include <alf/alftextvisual.h>

#include <alf/alfanchorlayout.h>

#include <alf/alfgradientbrush.h>

#include <alf/alfframebrush.h>

#include <alf/alfimagebrush.h>

#include <alf/alfshadowborderbrush.h>

#include <alf/alfbrusharray.h>

#include <alf/alftextstyle.h>

#include <AknsConstants.h>

#include <AknUtils.h>

#include <touchlogicalfeedback.h>

#include "fscontrolbuttonvisualiser.h"

#include "fscontrolbuttonmodel.h"

#include "fsgenericpanic.h"

#include "fstextstylemanager.h"

#include "fslayoutmanager.h"

#include "fscontrolbar.h"

const TInt KFsDefaultFontStyle = EAlfTextStyleNormal;

const TInt KDefaultShadowBorderWidth( 8 );

const TReal KShadowBorderOpacity( 0.08 );

const TInt KButtonBorderSize( 8 );

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

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

// Constructor.

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

//

EXPORT_C CFsControlButtonVisualiser::CFsControlButtonVisualiser(

    CAlfControl& aParent,

    CAlfDeckLayout& aParentLayout,

    CFsTextStyleManager* aTextStyleManager ) :

    iParent( &aParent ),

    iParentLayout( &aParentLayout ),

    iUpdateIconsAlign( EFalse ),

    iFirstDraw( ETrue ),

    iVisible( EFalse ),

    iTextStyleManager( aTextStyleManager )

    {

    FUNC_LOG;

    }

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

// Constructor.

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

//

EXPORT_C CFsControlButtonVisualiser::CFsControlButtonVisualiser() :

    iUpdateIconsAlign( EFalse ),

    iFirstDraw( ETrue ),

    iVisible( EFalse ),

    iTextStyleManager( NULL )

    {

    FUNC_LOG;

    }

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

// Second phase constructor.

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

//

EXPORT_C void CFsControlButtonVisualiser::ConstructL()

    {

    FUNC_LOG;

    if ( iParent )

        {

        // Visual for background content

        iButtonLayout = CAlfLayout::AddNewL( *iParent );

        iButtonLayout->SetTactileFeedbackL( ETouchEventStylusDown, ETouchFeedbackBasic );

        iButtonLayout->EnableBrushesL();

        iButtonContentLayout = CAlfLayout::AddNewL( *iParent );

        // Request callback after image is loaded to refresh it's size and

        // position.

        iParent->Env().TextureManager().AddLoadObserverL( this );

        }

    }

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

// Two-phased constructor.

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

//

CFsControlButtonVisualiser* CFsControlButtonVisualiser::NewL(

    CAlfControl& aParent,

    CAlfDeckLayout& aParentLayout,

    CFsTextStyleManager* aTextStyleManager )

    {

    FUNC_LOG;

    CFsControlButtonVisualiser* self =

        new(ELeave)CFsControlButtonVisualiser(

            aParent, aParentLayout, aTextStyleManager );

    CleanupStack::PushL( self );

    self->ConstructL();

    CleanupStack::Pop( self );

    return self;

    }

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

// Destructor.

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

//

EXPORT_C CFsControlButtonVisualiser::~CFsControlButtonVisualiser()

    {

    FUNC_LOG;

    ClearBackgroundImage();

    // removing from parent

    if ( iButtonLayout )

        {

        // If clase is only needed by debug version only.

        if ( KErrNotFound != iParentLayout->FindVisual( iButtonLayout ) )

            {

            iParentLayout->Remove( iButtonLayout );

            }

        iParent->Remove( iButtonLayout );

        iParent->Env().TextureManager().RemoveLoadObserver( this );

        delete iButtonLayout;

        }

    delete iBgColorBrush;

    delete iShadowBorderBrush;

    delete iTextFontSpec;

    }

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

// From class CFsControlButtonVisualiserBase.

// Initializes visualiser with model.

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

//

EXPORT_C void CFsControlButtonVisualiser::InitializeL(

    CFsControlButtonModel& aButtonModel )

    {

    FUNC_LOG;

    iButtonModel = &aButtonModel;

    // Add background color brush. This cannot be done in ConstructL as the

    // button model isn't set before.

    if ( !iBgColorBrush )

        {

        iBgColorBrush = CAlfGradientBrush::NewL( iParent->Env() );

        if( iShowShadow )

            {

            iBgColorBrush->SetOpacity( KShadowBorderOpacity ); 

            iBgColorBrush->SetColor(KRgbBlack);

            }

        else

            {

            iBgColorBrush->SetOpacity( 0 );

            }

        iBgColorBrush->SetLayer( EAlfBrushLayerBackground );

        iButtonLayout->Brushes()->AppendL( iBgColorBrush,

										   EAlfDoesNotHaveOwnership );

        }

    iUseDefaultBackground = ETrue;

    // Add a shadow border brush to outline the buttons with a shadowed border.

    if ( iShowShadow && !iShadowBorderBrush )

    	{

    	iShadowBorderBrush = CAlfShadowBorderBrush::NewL( 

    		iParent->Env(), TAlfMetric( KDefaultShadowBorderWidth ) );

    	iShadowBorderBrush->SetOpacity( KShadowBorderOpacity );

    	iShadowBorderBrush->SetLayer( EAlfBrushLayerBackground );

    	iButtonLayout->Brushes()->AppendL( iShadowBorderBrush,

										   EAlfDoesNotHaveOwnership );

    	}

    UpdateVisualThemeL();

    // create needed visuals

    CreateButtonVisualsL();

    UpdateBarLayout();

    }

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

// CFsControlButtonVisualiser::UpdateVisualThemeL

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

//

void CFsControlButtonVisualiser::UpdateVisualThemeL()

    {

    if( iUseDefaultBackground )

        {

        ClearBackgroundImage();

        iDefaultBgBrush = CAlfFrameBrush::NewL( iParent->Env(), KAknsIIDQsnFrButtonTb );  

        iBgBrush = iDefaultBgBrush;

        iButtonLayout->Brushes()->AppendL( iBgBrush, EAlfDoesNotHaveOwnership );

        UpdateBarLayout();

        }

    else if ( iBgColorBrush )

        {

        SetBackgroundColor( iButtonModel->TextColor(

            CFsControlButtonModel::EButtonBackground ) );

        }

    }

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

// From class CFsControlButtonVisualiserBase.

// Refreshes button's content.

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

//

EXPORT_C void CFsControlButtonVisualiser::Refresh()

    {

    FUNC_LOG;

    // draw only if enabled and ready for drawing

    if ( !IsVisible() )

        {

        return;

        }

    TBool buttonSizeChanged( iButtonModel->ButtonSizeChanged() );

    if ( buttonSizeChanged ||

        iButtonModel->AutoSizeMode()

            == MFsControlButtonInterface::EFsFitToContent ||

        iButtonModel->AutoSizeMode()

            == MFsControlButtonInterface::EFsFitToParent )

        {

        TSize buttonSize( iButtonModel->Size() );

        UpdateButtonSize();

        buttonSizeChanged |= buttonSize != iButtonModel->Size();

        }

    if ( buttonSizeChanged )

        {

        UpdateBarLayout();

        return;

        }

    if ( iButtonModel->ButtonPosChanged() )

        {

        UpdateButtonPos();

        if ( !buttonSizeChanged )

            {

            UpdateBarLayout();

            return;

            }

        }

    // recalculate icons alignement if needed

    if ( iUpdateIconsAlign || iFirstDraw )

        {

        if ( iButtonModel->ContainsElement( ECBElemIconA ) )

            {

            SetImageAlign( iIconA, iAIconHAlign, iAIconVAlign );

            }

        if ( iButtonModel->ContainsElement( ECBElemIconB ) )

            {

            SetImageAlign( iIconB, iBIconHAlign, iBIconVAlign );

            }

        iUpdateIconsAlign = EFalse;

        iFirstDraw = EFalse;

        }

    // if dimmed

    if ( iButtonModel->IsDimmed() )

        {

        PrepareDrawDimmed();

        }

    // if focused

    else if( iButtonModel->IsFocused() && iDrawFocus )

        {

        PrepareDrawFocused();

        }

    // normal - no focus, enabled

    else

        {

        PrepareDrawNormal();

        }

    }

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

// From class CFsControlButtonVisualiserBase.

// Refreshes button's content, sets topleft point of button in specified

// place.

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

//

EXPORT_C void CFsControlButtonVisualiser::Refresh( TPoint aStartAt )

    {

    FUNC_LOG;

    if ( iButtonModel->AutoPosition() )

        {

        TAlfRealPoint pos( aStartAt );

        if ( CFsLayoutManager::IsMirrored() )

            {

            TInt width( iParentLayout->Size().Target().iX );

            pos.iX = width - aStartAt.iX - iButtonLayout->Size().Target().iX;

            }

        // Set new position for background visual and it's content.

        iButtonLayout->SetFlag( EAlfVisualFlagManualPosition );

        iButtonContentLayout->SetFlag( EAlfVisualFlagManualPosition );

        iButtonLayout->SetPos( pos );

        iButtonContentLayout->SetPos( pos );

        }

    Refresh();

    }

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

// From class CFsControlButtonVisualiserBase.

// Retrieves end X coordinate of the button.

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

//

TInt CFsControlButtonVisualiser::GetBottomRight() const

    {

    FUNC_LOG;

    return

        iButtonModel->TopLeftPoint().iX + iButtonLayout->Size().iX.Target();

    }

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

// From class CFsControlButtonVisualiserBase.

// Retrieves position of the button.

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

//

const TAlfTimedPoint CFsControlButtonVisualiser::Pos() const

    {

    FUNC_LOG;

    return iButtonLayout->Pos();

    }

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

// From class CFsControlButtonVisualiserBase.

// Retrieves size of the button.

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

//

const TAlfTimedPoint CFsControlButtonVisualiser::Size() const

    {

    FUNC_LOG;

    return iButtonLayout->Size();

    }

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

// From class CFsControlButtonVisualiserBase.

// Sets background image of the button.

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

//

EXPORT_C void CFsControlButtonVisualiser::SetBackgroundImageL(

    CAlfImageBrush* aImage )

    {

    FUNC_LOG;

    // Release the old background image.

    ClearBackgroundImage();

    // As the ownership of the new brush is gained the pointer can't be lost.

    CleanupStack::PushL( aImage );

    iButtonLayout->Brushes()->InsertL( 0, aImage, EAlfDoesNotHaveOwnership );

    CleanupStack::Pop( aImage );

    iUseDefaultBackground = EFalse;

    iBgBrush = aImage;

    }

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

// Sets background color for button.

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

//

EXPORT_C void CFsControlButtonVisualiser::SetBackgroundColor(

    const TRgb& aColor )

    {

    FUNC_LOG;

    iBgColorBrush->SetColor( aColor );

    iBgColorBrush->SetOpacity( 1 );

    }

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

// Clears button's background color. Button is transparent.

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

//

EXPORT_C void CFsControlButtonVisualiser::ClearBackgroundColor()

    {

    FUNC_LOG;

    if( iBgColorBrush )

        {

        iBgColorBrush->SetOpacity( 0 );

        }

    }

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

// From class CFsControlButtonVisualiserBase.

// Clears background image of the button.

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

//

EXPORT_C void CFsControlButtonVisualiser::ClearBackgroundImage()

    {

    FUNC_LOG;

    if ( iBgBrush )

        {

        for ( TInt i( iButtonLayout->Brushes()->Count() - 1 ); 0 <= i; i-- )

            {

            if ( &iButtonLayout->Brushes()->At( i ) == iBgBrush )

                {

                iButtonLayout->Brushes()->Remove( i );

                break;

                }

            }

        delete iBgBrush;

        iBgBrush = NULL;

        iDefaultBgBrush = NULL;

        }

    }

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

// From class CFsControlButtonVisualiserBase.

// Sets alignement of element of the button.

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

//

EXPORT_C void CFsControlButtonVisualiser::SetElemAlignL(

    TFsControlButtonElem aButtonElem,

    TAlfAlignHorizontal aHAlign,

    TAlfAlignVertical aVAlign )

    {

    FUNC_LOG;

    TFsControlButtonType buttonType( iButtonModel->Type() );

    // check if button contains this element.

    if ( !iButtonModel->ContainsElement( aButtonElem ) )

        {

        FsGenericPanic( EFsControlButtonIncorrectButtonElement );

        User::Leave( KErrNotSupported );

        }

    switch ( aButtonElem )

        {

        case ECBElemIconA:

            {

            iAIconHAlign = aHAlign;

            iAIconVAlign = aVAlign;

            SetImageAlign( iIconA, aHAlign, aVAlign );

            break;

            }

        case ECBElemIconB:

            {

            iBIconHAlign = aHAlign;

            iBIconVAlign = aVAlign;

            SetImageAlign( iIconB, aHAlign, aVAlign );

            break;

            }

        case ECBElemLabelFirstLine:

            {

            SetTextAlign( iLabelFirstLine, aHAlign, aVAlign );

            break;

            }

        case ECBElemLabelSndLine:

            {

            SetTextAlign( iLabelSecondLine, aHAlign, aVAlign );

            break;

            }

        default:

            {

            // no other elements available

            FsGenericPanic( EFsControlButtonIncorrectButtonElement );

            break;

            }

        }

    }

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

// Update elemets after texture loading is completed.

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

//

EXPORT_C void CFsControlButtonVisualiser::TextureLoadingCompleted(

    CAlfTexture& aTexture,

    TInt /*aTextureId*/,

    TInt aErrorCode )

    {

    FUNC_LOG;

    if ( aErrorCode )

        {

        return;

        }

    // <cmail> Safety check added. Check why it is needed here.

    if ( iIconA &&