org.eclipse.swt.widgets.Item Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * Copyright (c) 2002, 2016 Innoopract Informationssysteme GmbH and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    Innoopract Informationssysteme GmbH - initial API and implementation
 *    EclipseSource - ongoing development
 ******************************************************************************/
package org.eclipse.swt.widgets;

import org.eclipse.swt.SWT;
import org.eclipse.swt.SWTException;
import org.eclipse.swt.graphics.Image;


/**
 * This class is the abstract superclass of all non-windowed
 * user interface objects that occur within specific controls.
 * For example, a tree will contain tree items.
 * 
 * Styles:
 * (none)
 * Events:
 * (none)
 * 
 */
public abstract class Item extends Widget {

  String text;
  Image image;

  /**
   * Constructs a new instance of this class given its parent
   * and a style value describing its behavior and appearance.
   * The item is added to the end of the items maintained by its parent.
   * 
   * The style value is either one of the style constants defined in
   * class SWT which is applicable to instances of this
   * class, or must be built by bitwise OR'ing together
   * (that is, using the int "|" operator) two or more
   * of those SWT style constants. The class description
   * lists the style constants that are applicable to the class.
   * Style bits are also inherited from superclasses.
   * 
   *
   * @param parent a widget which will be the parent of the new instance (cannot be null)
   * @param style the style of item to construct
   *
   * @exception IllegalArgumentException 
   *    ERROR_NULL_ARGUMENT - if the parent is null
   * 
   * @exception SWTException 
   *    ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
   * 
   *
   * @see SWT
   * @see Widget#getStyle
   */
  public Item( Widget parent, int style ) {
    super( parent, style );
    text = "";
  }

  /**
   * Constructs a new instance of this class given its parent
   * and a style value describing its behavior and appearance,
   * and the index at which to place it in the items maintained
   * by its parent.
   * 
   * The style value is either one of the style constants defined in
   * class SWT which is applicable to instances of this
   * class, or must be built by bitwise OR'ing together
   * (that is, using the int "|" operator) two or more
   * of those SWT style constants. The class description
   * lists the style constants that are applicable to the class.
   * Style bits are also inherited from superclasses.
   * 
   *
   * @param parent a widget which will be the parent of the new instance (cannot be null)
   * @param style the style of item to construct
   * @param index the zero-relative index at which to store the receiver in its parent
   *
   * @exception IllegalArgumentException 
   *    ERROR_NULL_ARGUMENT - if the parent is null
   *    ERROR_INVALID_RANGE - if the index is not between 0 and the number of elements in the parent (inclusive)
   * 
   * @exception SWTException 
   *    ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
   * 
   *
   * @see SWT
   * @see Widget#getStyle
   * @since 1.2
   */
  public Item( Widget parent, int style, int index ) {
    this( parent, style );
  }

  /**
   * Sets the receiver's text.
   *
   * @param text the new text
   *
   * @exception IllegalArgumentException 
   *    ERROR_NULL_ARGUMENT - if the text is null
   * 
   * @exception SWTException 
   *    ERROR_WIDGET_DISPOSED - if the receiver has been disposed
   *    ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
   * 
   */
  public void setText( String text ) {
    checkWidget();
    if( text == null ) {
      SWT.error( SWT.ERROR_NULL_ARGUMENT );
    }
    this.text = text;
  }

  /**
   * Returns the receiver's text, which will be an empty
   * string if it has never been set.
   *
   * @return the receiver's text
   *
   * @exception SWTException 
   *    ERROR_WIDGET_DISPOSED - if the receiver has been disposed
   *    ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
   * 
   */
  public String getText() {
    checkWidget();
    return text;
  }

  /**
   * Sets the receiver's image to the argument, which may be
   * null indicating that no image should be displayed.
   *
   * @param image the image to display on the receiver (may be null)
   *
   * @exception IllegalArgumentException 
   *    ERROR_INVALID_ARGUMENT - if the image has been disposed
   * 
   * @exception SWTException 
   *    ERROR_WIDGET_DISPOSED - if the receiver has been disposed
   *    ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
   * 
   */
  public void setImage( Image image ) {
    checkWidget();
    if( image != null && image.isDisposed() ) {
      SWT.error( SWT.ERROR_INVALID_ARGUMENT );
    }
    this.image = image;
  }

  /**
   * Returns the receiver's image if it has one, or null
   * if it does not.
   *
   * @return the receiver's image
   *
   * @exception SWTException 
   *    ERROR_WIDGET_DISPOSED - if the receiver has been disposed
   *    ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
   * 
   */
  public Image getImage() {
    checkWidget();
    return image;
  }

  @Override
  String getNameText() {
    return getText();
  }

}