org.eclipse.swt.widgets.Group Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2002, 2013 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.rap.rwt.internal.textsize.TextSizeUtil;
import org.eclipse.rap.rwt.internal.theme.IThemeAdapter;
import org.eclipse.swt.SWT;
import org.eclipse.swt.SWTException;
import org.eclipse.swt.graphics.Font;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.graphics.Rectangle;
import org.eclipse.swt.internal.widgets.groupkit.GroupThemeAdapter;
/**
* Instances of this class provide an etched border
* with an optional title.
*
* Shadow styles are hints and may not be honoured
* by the platform. To create a group with the
* default shadow style for the platform, do not
* specify a shadow style.
* The various SHADOW_* styles are not yet implemented.
*
* - Styles:
* - SHADOW_ETCHED_IN, SHADOW_ETCHED_OUT, SHADOW_IN, SHADOW_OUT, SHADOW_NONE
* - Events:
* - (none)
*
*
* Note: Only one of the above styles may be specified.
*
* IMPORTANT: This class is not intended to be subclassed.
*
*
* Note: The styles SHADOW_XXX are not yet implemented in RWT.
* @since 1.0
*/
public class Group extends Composite {
private String text;
/**
* Constructs a new instance of this class given its parent
* and a style value describing its behavior and appearance.
*
* 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.
*
* The various SHADOW_* styles are not yet implemented.
*
* @param parent a composite control which will be the parent of the new instance (cannot be null)
* @param style the style of control 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
* - ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass
*
*
*
*
* @see SWT#SHADOW_IN
* @see SWT#SHADOW_OUT
* @see SWT#SHADOW_NONE
* @see Widget#checkSubclass
* @see Widget#getStyle
*/
// TODO: [bm] implement shadow styles for Group
public Group( Composite parent, int style ) {
super( parent, checkStyle( style ) );
text = "";
}
/**
* Sets the receiver's text, which is the string that will
* be displayed as the receiver's title, to the argument,
* which may not be null. The string may include the mnemonic character.
*
* Mnemonics are indicated by an '&' that causes the next
* character to be the mnemonic. When the user presses a
* key sequence that matches the mnemonic, focus is assigned
* to the first child of the group. On most platforms, the
* mnemonic appears underlined but may be emphasised in a
* platform specific manner. The mnemonic indicator character
* '&' can be escaped by doubling it in the string, causing
* a single '&' to be displayed.
*
* @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 is the string that the
* is used as the title. If the text has not previously
* been set, returns an empty string.
*
* @return the 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;
}
@Override
public Rectangle getClientArea() {
checkWidget();
Rectangle bounds = getBounds();
GroupThemeAdapter themeAdapter = ( GroupThemeAdapter )getAdapter( IThemeAdapter.class );
Rectangle trimmings = themeAdapter.getTrimmingSize( this );
int border = getBorderWidth();
int width = Math.max( 0, bounds.width - trimmings.width - 2 * border );
int height = Math.max( 0, bounds.height - trimmings.height - 2 * border );
return new Rectangle( trimmings.x, trimmings.y, width, height );
}
@Override
public Rectangle computeTrim( int x, int y, int width, int height ) {
GroupThemeAdapter themeAdapter
= ( GroupThemeAdapter )getAdapter( IThemeAdapter.class );
Rectangle trimmings = themeAdapter.getTrimmingSize( this );
int border = getBorderWidth();
return super.computeTrim( x - trimmings.x - border,
y - trimmings.y - border,
width + trimmings.width + 2 * border,
height + trimmings.height + 2 * border );
}
@Override
public Point computeSize( int wHint, int hHint, boolean changed ) {
checkWidget();
Point result = super.computeSize( wHint, hHint, changed );
int length = text.length();
if( length != 0 ) {
Font font = getFont();
Point stringExtent = TextSizeUtil.stringExtent( font, text );
GroupThemeAdapter themeAdapter = ( GroupThemeAdapter )getAdapter( IThemeAdapter.class );
Rectangle headTrimmings = themeAdapter.getHeaderTrimmingSize( this );
int headerWidth = stringExtent.x + headTrimmings.width;
result.x = Math.max( result.x, headerWidth );
}
return result;
}
//////////////////
// Helping methods
@Override
String getNameText() {
return getText();
}
private static int checkStyle( int style ) {
int result = style | SWT.NO_FOCUS;
/*
* Even though it is legal to create this widget with scroll bars, they
* serve no useful purpose because they do not automatically scroll the
* widget's client area. The fix is to clear the SWT style.
*/
return result & ~( SWT.H_SCROLL | SWT.V_SCROLL );
}
}