com.github.rinde.rinsim.ui.renderers.PanelRenderer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rinsim-ui Show documentation

There is a newer version: 4.4.6

/*
 * Copyright (C) 2011-2015 Rinde van Lon, iMinds-DistriNet, KU Leuven
 *
 * 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 com.github.rinde.rinsim.ui.renderers;

import org.eclipse.swt.widgets.Composite;

/**
 * Using {@link PanelRenderer} a user interface panel can be defined. This panel
 * can be positioned alongside the canvas (which is the main view of the
 * simulation) to show additional information.
 * @author Rinde van Lon
 */
public interface PanelRenderer extends Renderer {

  /**
   * Sets the parent {@link Composite} of this panel. Through this method
   * {@link org.eclipse.swt.widgets.Control}s can be added to the panel.
   * @param parent The {@link Composite} which acts as parent of the panel.
   */
  void initializePanel(Composite parent);

  /**
   * Returns the preferred size, in pixels, of this panel. In case the position
   * of this panel is either SWT.TOP or SWT.BOTTOM
   * this values is interpreted as the preferred height. Else, if the
   * position is either SWT.LEFT or SWT.RIGHT it is
   * interpreted as the preferred width.
   * @return The preferred size in pixels.
   */
  int preferredSize();

  /**
   * Returns the preferred position of this panel relative to the canvas.
   * @return Possible values:
   *         
   *         SWT.TOP
   *         SWT.BOTTOM
   *         SWT.LEFT
   *         SWT.RIGHT
   *         
   */
  int getPreferredPosition();

  /**
   * @return The name of the panel.
   */
  String getName();

  /**
   * Signals that the panel can updates its contents.
   */
  void render();
}