/*!
 * This program is free software; you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software
 * Foundation.
 *
 * You should have received a copy of the GNU Lesser General Public License along with this
 * program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
 * or from the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 *
 * Copyright (c) 2002-2013 Pentaho Corporation..  All rights reserved.
 */

package org.pentaho.reporting.engine.classic.core.layout.build;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.pentaho.reporting.engine.classic.core.ReportElement;
import org.pentaho.reporting.engine.classic.core.SubReport;
import org.pentaho.reporting.engine.classic.core.function.ProcessingContext;
import org.pentaho.reporting.engine.classic.core.layout.InlineSubreportMarker;
import org.pentaho.reporting.engine.classic.core.layout.model.RenderBox;
import org.pentaho.reporting.engine.classic.core.layout.output.OutputProcessorFeature;
import org.pentaho.reporting.engine.classic.core.layout.output.OutputProcessorMetaData;
import org.pentaho.reporting.engine.classic.core.util.InstanceID;

public class HeaderLayoutModelBuilder extends LayoutModelBuilderWrapper implements Cloneable {
  private static final Log logger = LogFactory.getLog( HeaderLayoutModelBuilder.class );

  private RenderBox parentBox;
  private int inBoxDepth;
  private OutputProcessorMetaData metaData;

  public HeaderLayoutModelBuilder( final LayoutModelBuilder backend ) {
    super( backend );
    backend.setLimitedSubReports( true );
    backend.setCollapseProgressMarker( false );
  }

  public void initialize( final ProcessingContext metaData, final RenderBox parentBox,
      final RenderNodeFactory renderNodeFactory ) {
    this.parentBox = parentBox;
    getParent().initialize( metaData, parentBox, renderNodeFactory );
    this.metaData = metaData.getOutputProcessorMetaData();
  }

  public void setLimitedSubReports( final boolean limitedSubReports ) {

  }

  public InstanceID startBox( final ReportElement element ) {
    InstanceID instanceID = super.startBox( element );
    inBoxDepth += 1;
    return instanceID;
  }

  public void startSection( final ReportElement element, final int sectionSize ) {
    throw new UnsupportedOperationException( "Global sections cannot be started for page headers" );
  }

  public InlineSubreportMarker processSubReport( final SubReport element ) {
    return null;
  }

  public boolean finishBox() {
    inBoxDepth -= 1;
    return super.finishBox();
  }

  public void endSubFlow() {
    throw new UnsupportedOperationException( "SubReport sections cannot be started for page headers" );
  }

  public void addProgressMarkerBox() {
    if ( inBoxDepth != 0 ) {
      throw new IllegalStateException();
    }
    super.addProgressMarkerBox();
  }

  public void addManualPageBreakBox( final long range ) {
    throw new UnsupportedOperationException( "PageBreak sections cannot be started for page headers" );
  }

  public LayoutModelBuilder deriveForStorage( final RenderBox clonedContent ) {
    final HeaderLayoutModelBuilder clone = (HeaderLayoutModelBuilder) super.deriveForStorage( clonedContent );
    clone.parentBox = clonedContent;
    return clone;
  }

  public void startSection() {
    if ( inBoxDepth != 0 ) {
      throw new IllegalStateException();
    }

    parentBox.clear();
    super.startSection();
  }

  public void endSection() {
    if ( inBoxDepth != 0 ) {
      throw new IllegalStateException();
    }

    if ( metaData.isFeatureSupported( OutputProcessorFeature.STRICT_COMPATIBILITY ) ) {
      super.legacyFlagNotEmpty();
    }
    super.endSection();
  }

  public InstanceID createSubflowPlaceholder( final ReportElement element ) {
    throw new UnsupportedOperationException( "SubReport sections cannot be started for page headers" );
  }

  public void startSubFlow( final InstanceID insertationPoint ) {
    throw new UnsupportedOperationException( "SubReport sections cannot be started for page headers" );
  }

  public void startSubFlow( final ReportElement element ) {
    throw new UnsupportedOperationException( "SubReport sections cannot be started for page headers" );
  }

  public void suspendSubFlow() {
    throw new UnsupportedOperationException( "SubReport sections cannot be started for page headers" );
  }
}