org.eclipse.swt.widgets.Group Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2000, 2012 IBM Corporation 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:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.swt.widgets;
import org.eclipse.swt.*;
import org.eclipse.swt.graphics.*;
import org.eclipse.swt.internal.cocoa.*;
/**
* 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.
*
* - 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.
*
*
* @see SWT Example: ControlExample
* @see Sample code and further information
* @noextend This class is not intended to be subclassed by clients.
*/
public class Group extends Composite {
NSView contentView;
String text = "";
boolean ignoreResize;
int hMargin, vMargin;
/**
* 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.
*
*
* @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_ETCHED_IN
* @see SWT#SHADOW_ETCHED_OUT
* @see SWT#SHADOW_IN
* @see SWT#SHADOW_OUT
* @see SWT#SHADOW_NONE
* @see Widget#checkSubclass
* @see Widget#getStyle
*/
public Group (Composite parent, int style) {
super (parent, checkStyle (style));
}
static int checkStyle (int style) {
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 style & ~(SWT.H_SCROLL | SWT.V_SCROLL);
}
@Override
protected void checkSubclass () {
if (!isValidSubclass ()) error (SWT.ERROR_INVALID_SUBCLASS);
}
@Override
public Rectangle computeTrim (int x, int y, int width, int height) {
checkWidget ();
NSBox widget = (NSBox)view;
NSRect newRect = new NSRect();
newRect.x = x;
newRect.y = y;
newRect.width = width;
newRect.height = height;
NSRect oldRect = widget.frame();
ignoreResize = true;
widget.setFrameFromContentFrame(newRect);
newRect = widget.frame();
widget.setFrame(oldRect);
ignoreResize = false;
x = (int) Math.ceil(newRect.x) - hMargin;
y = (int) Math.ceil(newRect.y) - vMargin;
width = (int) Math.ceil(newRect.width) + (hMargin * 2);
height = (int) Math.ceil(newRect.height) + (vMargin * 2);
return super.computeTrim(x, y, width, height);
}
@Override
NSView contentView () {
return contentView;
}
@Override
void createHandle () {
state |= THEME_BACKGROUND;
NSBox widget = (NSBox)new SWTBox().alloc();
widget.init();
widget.setTitlePosition(OS.NSNoTitle);
NSSize margins = widget.contentViewMargins();
hMargin = (int) margins.width;
vMargin = (int) margins.height;
widget.setContentViewMargins(new NSSize());
NSView contentWidget = (NSView)new SWTView().alloc();
contentWidget.init();
// contentWidget.setDrawsBackground(false);
widget.setContentView(contentWidget);
contentView = contentWidget;
view = widget;
}
@Override
NSFont defaultNSFont () {
return display.boxFont;
}
@Override
void deregister () {
super.deregister ();
display.removeWidget (contentView);
SWTBox box = (SWTBox)view;
display.removeWidget (box.titleCell());
}
@Override
void drawBackground (long /*int*/ id, NSGraphicsContext context, NSRect rect) {
if (id != view.id) return;
fillBackground (view, context, rect, -1);
}
@Override
NSView eventView () {
return contentView;
}
@Override
public Rectangle getClientArea () {
checkWidget();
NSRect rect = contentView.bounds();
int width = Math.max (0, (int) rect.width - hMargin * 2);
int height = Math.max (0, (int) rect.height - vMargin * 2);
return new Rectangle((int)(rect.x) + hMargin, (int)(rect.y) + vMargin, width, height);
}
@Override
String getNameText () {
return getText ();
}
/**
* 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
boolean isTransparent() {
return true;
}
@Override
float getThemeAlpha () {
return (background != null ? 1 : 0.25f) * parent.getThemeAlpha ();
}
@Override
void register () {
super.register ();
display.addWidget (contentView, this);
SWTBox box = (SWTBox)view;
display.addWidget (box.titleCell(), this);
}
@Override
void releaseHandle () {
super.releaseHandle ();
if (contentView != null) contentView.release();
contentView = null;
}
@Override
void resized() {
if (!ignoreResize) super.resized();
}
@Override
void setFont(NSFont font) {
((NSBox) view).setTitleFont(font);
}
@Override
void setForeground (double /*float*/ [] color) {
NSColor nsColor;
if (color == null) {
nsColor = NSColor.textColor ();
} else {
nsColor = NSColor.colorWithDeviceRed (color[0], color[1], color[2], 1);
}
NSTextFieldCell cell = new NSTextFieldCell (((NSBox)view).titleCell ().id);
cell.setTextColor (nsColor);
}
@Override
void setOrientation () {
int direction = (style & SWT.RIGHT_TO_LEFT) != 0 ? OS.NSWritingDirectionRightToLeft : OS.NSWritingDirectionLeftToRight;
NSTextFieldCell cell = new NSTextFieldCell (((NSBox)view).titleCell ().id);
cell.setBaseWritingDirection(direction);
}
/**
* 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.
*
* Note: If control characters like '\n', '\t' etc. are used
* in the string, then the behavior is platform dependent.
*
* @param string 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 string) {
checkWidget();
if (string == null) error (SWT.ERROR_NULL_ARGUMENT);
text = string;
char [] buffer = new char [text.length ()];
text.getChars (0, buffer.length, buffer, 0);
int length = fixMnemonic (buffer);
NSBox box = (NSBox)view;
box.setTitlePosition(length == 0 ? OS.NSNoTitle : OS.NSAtTop);
box.setTitle(NSString.stringWithCharacters(buffer, length));
}
}