/*

  * Copyright 2004-2008 the Seasar Foundation and the Others.

  *

  * Licensed under the Apache License, Version 2.0 (the "License");

  * you may not use this file except in compliance with the License.

  * You may obtain a copy of the License at

  *

  *     http://www.apache.org/licenses/LICENSE-2.0

  *

  * Unless required by applicable law or agreed to in writing, software

  * distributed under the License is distributed on an "AS IS" BASIS,

  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, 

  * either express or implied. See the License for the specific language

  * governing permissions and limitations under the License.

  */

 package org.seasar.uruma.renderer.impl;

 import org.eclipse.jface.viewers.ContentViewer;

 import org.eclipse.jface.viewers.IBaseLabelProvider;

 import org.eclipse.jface.viewers.IContentProvider;

 import org.eclipse.jface.viewers.StructuredViewer;

 import org.eclipse.jface.viewers.Viewer;

 import org.eclipse.jface.viewers.ViewerComparator;

 import org.eclipse.swt.widgets.Composite;

 import org.eclipse.swt.widgets.Control;

 import org.seasar.framework.util.StringUtil;

 import org.seasar.uruma.component.UIComponent;

 import org.seasar.uruma.component.UICompositeComponent;

 import org.seasar.uruma.component.jface.CompositeComponent;

 import org.seasar.uruma.context.PartContext;

 import org.seasar.uruma.context.WidgetHandle;

 import org.seasar.uruma.core.ComponentUtil;

 import org.seasar.uruma.core.UrumaMessageCodes;

 import org.seasar.uruma.log.UrumaLogger;

 import org.seasar.uruma.util.ClassUtil;

 import org.seasar.uruma.viewer.GenericContentProvider;

 import org.seasar.uruma.viewer.PojoLabelProvider;

 /**

  * {@link Viewer} のレンダリングを行うための基底クラスです。<br />

  * 

  * @param <COMPONENT_TYPE>

  *            レンダラに対応するコンポーネントの実際の型

  * @param <VIEWER_TYPE>

  *            レンダラが生成するビューアの実際の型

  * @param <CONTROL_TYPE>

  *            ビューアが内包する {@link Control} オブジェクトの実際の型

  * @author y-komori

  */

 public abstract class AbstractViewerRenderer<COMPONENT_TYPE extends CompositeComponent, VIEWER_TYPE extends Viewer, CONTROL_TYPE extends Control>

         extends AbstractControlRenderer<COMPONENT_TYPE, CONTROL_TYPE> {

     private UrumaLogger logger = UrumaLogger.getLogger(getClass());

     /*

      * @see org.seasar.uruma.renderer.Renderer#render(org.seasar.uruma.component.UIComponent,

      *      org.seasar.uruma.context.WidgetHandle,

      *      org.seasar.uruma.context.PartContext)

      */

     @Override

     @SuppressWarnings("unchecked")

     public WidgetHandle render(final UIComponent uiComponent,

             final WidgetHandle parent, final PartContext context) {

         if (!canCreateViewer(UICompositeComponent.class.cast(uiComponent))) {

             // ビューアを生成しない場合の処理

             return super.render(uiComponent, parent, context);

         }

         setContext(context);

         inherit((COMPONENT_TYPE) uiComponent);

         VIEWER_TYPE viewer = createViewer(parent.<Composite> getCastWidget(),

                 getStyle(uiComponent));

         // ビューアに内包されるウィジットのレンダリングを行う

         renderWidget((COMPONENT_TYPE) uiComponent, (CONTROL_TYPE) viewer

                 .getControl());

         String id = uiComponent.getId();

         if (viewer instanceof ContentViewer) {

             ComponentUtil.setupContentProvider((ContentViewer) viewer, id,

                     getDefaultContentProvider());

         }

         if (viewer instanceof StructuredViewer) {

             ComponentUtil.setupLabelProvider((StructuredViewer) viewer, id,

                     getDefaultLabelProvider(), getLabelProviderClass(),

                     getPojoLabelProviderClass());

         }

         doRenderViewer((COMPONENT_TYPE) uiComponent, viewer);

         WidgetHandle viewerHandle = createWidgetHandle(uiComponent, viewer);

         if (!StringUtil.isEmpty(id)) {

             viewerHandle.setId(id);

         }

         return viewerHandle;

     }

     /*

      * @see org.seasar.uruma.renderer.Renderer#renderAfter(org.seasar.uruma.context.WidgetHandle,

      *      org.seasar.uruma.component.UIComponent,

      *      org.seasar.uruma.context.WidgetHandle,

      *      org.seasar.uruma.context.PartContext)

      */

     @Override

     @SuppressWarnings("unchecked")

     public void renderAfter(final WidgetHandle handle,

             final UIComponent uiComponent, final WidgetHandle parent,

             final PartContext context) {

         if (handle.instanceOf(Viewer.class)) {

             VIEWER_TYPE viewer = getViewerType().cast(handle.getWidget());

             WidgetHandle controlHandle = createWidgetHandle(uiComponent, viewer

                     .getControl());

             super.renderAfter(controlHandle, uiComponent, parent, context);

             doRenderAfter(viewer, (COMPONENT_TYPE) uiComponent, parent, context);

             if (viewer instanceof StructuredViewer) {

                 ComponentUtil.setupComparator((StructuredViewer) viewer,

                         uiComponent.getId(), getDefaultComparator());

             }

         } else {

             super.renderAfter(handle, uiComponent, parent, context);

         }

     }

     /*

      * @see org.seasar.uruma.renderer.impl.AbstractControlRenderer#doRenderControl(org.seasar.uruma.component.jface.ControlComponent,

      *      org.eclipse.swt.widgets.Control)

      */

     @Override

     protected void doRenderControl(final COMPONENT_TYPE controlComponent,

             final CONTROL_TYPE control) {

         // Do nothing.

     }

     /**

      * ビューアを生成します。<br />

      * ビューアの生成を独自に行いたい場合、サブクラスで本メソッドをオーバーライドしてください。<br />

      * 

      * @param parent

      *            親 {@link Composite}

      * @param style

      *            スタイル

      * @return 生成したビューアのインタンス

      */

     protected VIEWER_TYPE createViewer(final Composite parent, final int style) {

         VIEWER_TYPE viewer = ClassUtil.<VIEWER_TYPE> newInstance(

                 getViewerType(), parent, style);

         if (logger.isTraceEnabled()) {

             logger.log(UrumaMessageCodes.WIDGET_CREATED, UrumaLogger

                     .getObjectDescription(viewer));

         }

         return viewer;

     }

     /**

      * デフォルトの {@link IContentProvider} を返します。<br />

      * ユーザ指定の {@link IContentProvider} が S2Container

      * 上に登録されていない場合に使用する、デフォルトのコンテントプロバイダを返します。<br />

      * デフォルトでは、 {@link GenericContentProvider} を返します。<br />

      * デフォルトのコンテントプロバイダを変更したい場合、本メソッドをオーバーライドしてください。<br />

      * 

      * @return デフォルトの {@link IContentProvider}

      */

     protected IContentProvider getDefaultContentProvider() {

         return new GenericContentProvider();

     }

     /**

      * デフォルトの {@link IBaseLabelProvider} を返します。<br />

      * ユーザ指定の {@link IBaseLabelProvider} が S2Container

      * 上に登録されていない場合に使用する、デフォルトのラベルプロバイダを返します。<br />

      * デフォルトでは、 <code>null</code> (ラベルプロバイダを使用しない) を返します。<br />

      * デフォルトのラベルプロバイダを変更したい場合、本メソッドをオーバーライドしてください。<br />

      * 

      * @return デフォルトの {@link IBaseLabelProvider}

      */

     protected IBaseLabelProvider getDefaultLabelProvider() {

         return null;

     }

     /**

      * ラベルプロバイダとして使用すべきクラスを返します。<br />

      * S2Container 上でラベルプロバイダを検索する際、本メソッドの戻り値で示される型のインスタンスであるかどうかをチェックします。<br />

      * デフォルトでは、 {@link IBaseLabelProvider} の {@link Class} オブジェクトを返します。<br />

      * ラベルプロバイダのクラスをさらに絞りたい場合、本メソッドをオーバーライドしてください。<br />

      * 

      * @return ラベルプロバイダとして使用すべきクラス

      */

     protected Class<? extends IBaseLabelProvider> getLabelProviderClass() {

         return IBaseLabelProvider.class;

     }

     /**

      * POJO をラベルプロバイダとして利用する場合のアダプタクラスを返します。<br />

      * デフォルトでは <code>null</code>

      * を返しますので、必要に応じてサブクラスでオーバーライドして、適切なクラスオブジェクトを返してください。

      * 

      * @return {@link PojoLabelProvider} のクラス

      */

     protected Class<? extends PojoLabelProvider> getPojoLabelProviderClass() {

         return null;

     }

     /**

      * デフォルトの {@link ViewerComparator} を返します。<br />

      * ユーザ指定の {@link ViewerComparator} が S2Container

      * 上に登録されていない場合に使用する、デフォルトのソータを返します。<br />

      * デフォルトのコンパレータを変更したい場合、本メソッドをオーバーライドしてください。<br />

      * デフォルトでは <code>null</code> (ソートしない) を返します。<br />

      * 

      * @return デフォルトの {@link ViewerComparator}}

      */

     protected ViewerComparator getDefaultComparator() {

         return null;

     }

     /**

      * 生成するビューアの型を返します。<br />

      * ビューアのインスタンス生成は本クラスで実施するので、サブクラスで本メソッドを実装してビューアの型のみを返してください。

      * 

      * @return 生成するビューアの型

      */

     protected abstract Class<VIEWER_TYPE> getViewerType();

     /**

      * ビューアを生成するかどうかを判定します。<br />

      * ビューアの生成を制御したい場合、サブクラスでオーバーライドしてください。<br />

      * デフォルトでは <code>true</code> を返します。<br />

      * 

      * @param component

      *            対応する {@link UICompositeComponent}

      * @return 生成する場合は <code>true</code>。しない場合は <code>false</code>

      */

     protected boolean canCreateViewer(final UICompositeComponent component) {

         return true;

     }

     /**

      * 生成されたビューアに対して各種属性を設定します。<br />

      * 必要な場合は本メソッドをオーバーライドして、<code>uiComponent</code> の保持する属性を

      * <code>viewer</code> に対して設定してください。<br />

      * デフォルトの実装では何も行いません。<br />

      * 

      * @param uiComponent

      *            {@link UIComponent} オブジェクト

      * @param viewer

      *            生成されたビューア

      */

     protected void doRenderViewer(final COMPONENT_TYPE uiComponent,

             final VIEWER_TYPE viewer) {

         // Do nothing.

     }

     /**

      * 子のレンダリング終了後にレンダリング処理を行います。<br />

      * 子のレンダリング終了後にレンダリング処理を行う場合、本メソッドをオーバーライドしてレンダリング処理を実装してください。<br />

      * デフォルトでは何も行いません。<br />

      * 

      * @param viewer

      *            レンダリング対象ビューア

      * @param uiComponent

      *            レンダリング対象の {@link UIComponent} オブジェクト

      * @param parent

      *            親のウィジットハンドル

      * @param context

      *            {@link PartContext} オブジェクト

      */

     protected void doRenderAfter(final VIEWER_TYPE viewer,

             final COMPONENT_TYPE uiComponent, final WidgetHandle parent,

             final PartContext context) {

         // do nothing.

     }

 }