com.cedarsoft.swing.presenter.SwingPresenter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of swing-presenter Show documentation
The newest version!
/**
 * Copyright (C) cedarsoft GmbH.
 *
 * Licensed under the GNU General Public License version 3 (the "License")
 * with Classpath Exception; you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 *         http://www.cedarsoft.org/gpl3ce
 *         (GPL 3 with Classpath Exception)
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 3 only, as
 * published by the Free Software Foundation. cedarsoft GmbH designates this
 * particular file as subject to the "Classpath" exception as provided
 * by cedarsoft GmbH in the LICENSE file that accompanied this code.
 *
 * This code 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 General Public License
 * version 3 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 3 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact cedarsoft GmbH, 72810 Gomaringen, Germany,
 * or visit www.cedarsoft.com if you need additional information or
 * have any questions.
 */

package com.cedarsoft.swing.presenter;

import com.cedarsoft.commons.struct.StructPart;
import com.cedarsoft.presenter.AbstractPresenter;
import com.cedarsoft.presenter.Presenter;

import javax.annotation.Nonnull;

import javax.swing.JComponent;

/**
 * Base class for swing presenters.
 *
 * @author Johannes Schneider ([email protected])
 */
public abstract class SwingPresenter extends AbstractPresenter {
  /**
   * {@inheritDoc}
   */
  @Override
  protected void removeChildPresentation( @Nonnull T presentation, @Nonnull StructPart child, int index ) {
    presentation.remove( index );
    presentation.validate();
  }

  /**
   * {@inheritDoc}
   */
  @Override
  protected boolean addChildPresentation( @Nonnull T presentation, @Nonnull StructPart child, int index ) {
    Presenter childPresenter = getChildPresenter( child );
    return addChild( presentation, index, childPresenter.present( child ) );
  }

  /**
   * addChild
   *
   * @param presentation      a T object.
   * @param index             a int.
   * @param childPresentation a JComponent object.
   * @return a boolean.
   */
  protected boolean addChild( @Nonnull T presentation, int index, @Nonnull JComponent childPresentation ) {
    presentation.add( childPresentation, index );
    presentation.validate();
    return true;
  }

  /**
   * getChildPresenter
   *
   * @param child a StructPart object.
   * @return a com.cedarsoft.presenter.Presenter object.
   */
  @Nonnull
  protected abstract Presenter getChildPresenter( @Nonnull StructPart child );
}