/******************************************************************************* * Copyright (c) 2000, 2011 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 represent a non-selectable * user interface object that displays a string or image. * When SEPARATOR is specified, displays a single * vertical or horizontal line. *

* Shadow styles are hints and may not be honored * by the platform. To create a separator label * with the default shadow style for the platform, * do not specify a shadow style. *

*
*
Styles:
*
SEPARATOR, HORIZONTAL, VERTICAL
*
SHADOW_IN, SHADOW_OUT, SHADOW_NONE
*
CENTER, LEFT, RIGHT, WRAP
*
Events:
*
(none)
*
*

* Note: Only one of SHADOW_IN, SHADOW_OUT and SHADOW_NONE may be specified. * SHADOW_NONE is a HINT. Only one of HORIZONTAL and VERTICAL may be specified. * Only one of CENTER, LEFT and RIGHT may be specified. *

* IMPORTANT: This class is not intended to be subclassed. *

* * @see Label snippets * @see SWT Example: ControlExample * @see Sample code and further information * @noextend This class is not intended to be subclassed by clients. */ public class Label extends Control { String text; Image image; boolean isImage; NSTextField textView; NSImageView imageView; NSView separator; /** * 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 * @exception SWTException * * @see SWT#SEPARATOR * @see SWT#HORIZONTAL * @see SWT#VERTICAL * @see SWT#SHADOW_IN * @see SWT#SHADOW_OUT * @see SWT#SHADOW_NONE * @see SWT#CENTER * @see SWT#LEFT * @see SWT#RIGHT * @see SWT#WRAP * @see Widget#checkSubclass * @see Widget#getStyle */ public Label (Composite parent, int style) { super (parent, checkStyle (style)); } int /*long*/ accessibleHandle() { return eventView().id; } boolean accessibilityIsIgnored(int /*long*/ id, int /*long*/ sel) { if (id == view.id) return true; return super.accessibilityIsIgnored(id, sel); } void addRelation (Control control) { if (!control.isDescribedByLabel ()) return; if (textView != null) { NSObject accessibleElement = control.focusView(); if (accessibleElement instanceof NSControl) { NSControl viewAsControl = (NSControl)accessibleElement; if (viewAsControl.cell() != null) accessibleElement = viewAsControl.cell(); } accessibleElement.accessibilitySetOverrideValue(textView.cell(), OS.NSAccessibilityTitleUIElementAttribute); NSArray controlArray = NSArray.arrayWithObject(accessibleElement); textView.cell().accessibilitySetOverrideValue(controlArray, OS.NSAccessibilityServesAsTitleForUIElementsAttribute); } } static int checkStyle (int style) { style |= SWT.NO_FOCUS; if ((style & SWT.SEPARATOR) != 0) { style = checkBits (style, SWT.VERTICAL, SWT.HORIZONTAL, 0, 0, 0, 0); return checkBits (style, SWT.SHADOW_OUT, SWT.SHADOW_IN, SWT.SHADOW_NONE, 0, 0, 0); } return checkBits (style, SWT.LEFT, SWT.CENTER, SWT.RIGHT, 0, 0, 0); } public Point computeSize (int wHint, int hHint, boolean changed) { checkWidget(); int width = DEFAULT_WIDTH; int height = DEFAULT_HEIGHT; if ((style & SWT.SEPARATOR) != 0) { float /*double*/ lineWidth = ((NSBox)view).borderWidth (); if ((style & SWT.HORIZONTAL) != 0) { height = (int)Math.ceil (lineWidth * 2); } else { width = (int)Math.ceil (lineWidth * 2); } if (wHint != SWT.DEFAULT) width = wHint; if (hHint != SWT.DEFAULT) height = hHint; int border = getBorderWidth (); width += border * 2; height += border * 2; return new Point (width, height); } if (isImage) { if (image != null) { NSImage nsimage = image.handle; NSSize size = nsimage.size (); width = (int)size.width; height = (int)size.height; } else { width = height = 0; } } else { NSSize size = null; if ((style & SWT.WRAP) != 0 && wHint != SWT.DEFAULT) { NSRect rect = new NSRect (); rect.width = wHint; rect.height = hHint != SWT.DEFAULT ? hHint : Float.MAX_VALUE; size = textView.cell ().cellSizeForBounds (rect); } else { size = textView.cell ().cellSize (); } width = (int)Math.ceil (size.width); height = (int)Math.ceil (size.height); } if (wHint != SWT.DEFAULT) width = wHint; if (hHint != SWT.DEFAULT) height = hHint; return new Point (width, height); } void createHandle () { state |= THEME_BACKGROUND; NSBox widget = (NSBox)new SWTBox().alloc(); if ((style & SWT.SEPARATOR) != 0) { /* * Feature in Cocoa: Separator control decides how to orient itself * based on the width and height. If height > width it orients * vertically, else it orients horizontally. * Fix is to have two native controls to implement the separator label. * The top control (Custom NSBox) honors the bounds set by the * user and the inner one (Separator NSBox) creates the separator * with the correct orientation. */ NSRect rect = new NSRect(); rect.width = DEFAULT_WIDTH; rect.height = DEFAULT_HEIGHT; widget.initWithFrame(rect); widget.setTitle(NSString.string()); widget.setBorderType(OS.NSNoBorder); widget.setBoxType (OS.NSBoxCustom); widget.setContentViewMargins (new NSSize()); float /*double*/ lineWidth = widget.borderWidth (); if ((style & SWT.HORIZONTAL) != 0) { rect.height = (int)Math.ceil (lineWidth * 2); rect.y = (DEFAULT_HEIGHT / 2) - (rect.height / 2); } else { rect.width = (int)Math.ceil (lineWidth * 2); rect.x = (DEFAULT_WIDTH / 2) - (rect.width / 2); } NSBox separator = (NSBox) new SWTBox().alloc(); separator.initWithFrame(rect); separator.setBoxType(OS.NSBoxSeparator); if ((style & SWT.HORIZONTAL) != 0) { separator.setAutoresizingMask(OS.NSViewWidthSizable | OS.NSViewMinYMargin | OS.NSViewMaxYMargin); } else { separator.setAutoresizingMask(OS.NSViewHeightSizable| OS.NSViewMinXMargin | OS.NSViewMaxXMargin); } NSView child = (NSView) new NSView().alloc().init(); separator.setContentView(child); child.release(); widget.addSubview(separator); this.separator = separator; } else { widget.init(); widget.setTitle(NSString.string()); widget.setBorderType(OS.NSNoBorder); widget.setBorderWidth (0); widget.setBoxType (OS.NSBoxCustom); NSSize offsetSize = new NSSize (); widget.setContentViewMargins (offsetSize); NSImageView imageWidget = (NSImageView) new SWTImageView ().alloc (); imageWidget.init(); imageWidget.setImageScaling (OS.NSScaleNone); NSTextField textWidget = (NSTextField)new SWTTextField().alloc(); textWidget.init(); textWidget.setBordered(false); textWidget.setEditable(false); textWidget.setDrawsBackground(false); NSTextFieldCell cell = new NSTextFieldCell(textWidget.cell()); cell.setWraps ((style & SWT.WRAP) != 0); widget.addSubview(imageWidget); widget.addSubview(textWidget); widget.setContentView(textWidget); imageView = imageWidget; textView = textWidget; _setAlignment(); } view = widget; } void createWidget() { text = ""; super.createWidget (); } NSAttributedString createString() { NSAttributedString attribStr = createString(text, null, foreground, style, (style & SWT.WRAP) != 0, true, true); attribStr.autorelease(); return attribStr; } NSFont defaultNSFont () { return display.textFieldFont; } void deregister () { super.deregister (); if (textView != null) { display.removeWidget(textView); display.removeWidget(textView.cell()); } if (imageView != null) { display.removeWidget (imageView); display.removeWidget (imageView.cell()); } if (separator != null) display.removeWidget(separator); } void drawBackground (int /*long*/ id, NSGraphicsContext context, NSRect rect) { if (id != view.id) return; fillBackground(view, context, rect, -1); } int /*long*/ imageView() { return imageView.id; }; boolean drawsBackground() { return background != null || backgroundImage != null; } NSView eventView () { return ((NSBox)view).contentView(); } /** * Returns a value which describes the position of the * text or image in the receiver. The value will be one of * LEFT, RIGHT or CENTER * unless the receiver is a SEPARATOR label, in * which case, NONE is returned. * * @return the alignment * * @exception SWTException */ public int getAlignment () { checkWidget(); if ((style & SWT.SEPARATOR) != 0) return SWT.LEFT; if ((style & SWT.CENTER) != 0) return SWT.CENTER; if ((style & SWT.RIGHT) != 0) return SWT.RIGHT; return SWT.LEFT; } /** * Returns the receiver's image if it has one, or null * if it does not. * * @return the receiver's image * * @exception SWTException */ public Image getImage () { checkWidget(); return image; } String getNameText () { return getText (); } /** * Returns the receiver's text, which will be an empty * string if it has never been set or if the receiver is * a SEPARATOR label. * * @return the receiver's text * * @exception SWTException */ public String getText () { checkWidget(); if ((style & SWT.SEPARATOR) != 0) return ""; return text; } boolean isDescribedByLabel () { return false; } void register () { super.register (); if (textView != null) { display.addWidget (textView, this); display.addWidget (textView.cell(), this); } if (imageView != null) { display.addWidget (imageView, this); display.addWidget (imageView.cell(), this); } if (separator != null) display.addWidget(separator, this); } void releaseHandle () { super.releaseHandle (); if (textView != null) textView.release(); if (imageView != null) imageView.release(); if (separator != null) separator.release(); textView = null; imageView = null; separator = null; } /* * Remove "Labeled by" relations from the receiver. */ void removeRelation () { if (textView != null) { textView.cell().accessibilitySetOverrideValue(null, OS.NSAccessibilityServesAsTitleForUIElementsAttribute); } } /** * Controls how text and images will be displayed in the receiver. * The argument should be one of LEFT, RIGHT * or CENTER. If the receiver is a SEPARATOR * label, the argument is ignored and the alignment is not changed. * * @param alignment the new alignment * * @exception SWTException */ public void setAlignment (int alignment) { checkWidget(); if ((style & SWT.SEPARATOR) != 0) return; if ((alignment & (SWT.LEFT | SWT.RIGHT | SWT.CENTER)) == 0) return; style &= ~(SWT.LEFT | SWT.RIGHT | SWT.CENTER); style |= alignment & (SWT.LEFT | SWT.RIGHT | SWT.CENTER); _setAlignment(); } void _setAlignment() { if (image != null) { if ((style & SWT.RIGHT) != 0) imageView.setImageAlignment(OS.NSImageAlignRight); if ((style & SWT.LEFT) != 0) imageView.setImageAlignment(OS.NSImageAlignLeft); if ((style & SWT.CENTER) != 0) imageView.setImageAlignment(OS.NSImageAlignCenter); } if (text != null) { NSCell cell = new NSCell(textView.cell()); cell.setAttributedStringValue(createString()); } } void setFont(NSFont font) { if (textView != null) { NSCell cell = new NSCell(textView.cell()); cell.setAttributedStringValue(createString()); textView.setFont (font); } } void setForeground (float /*double*/ [] color) { if ((style & SWT.SEPARATOR) != 0) return; NSCell cell = new NSCell(textView.cell()); cell.setAttributedStringValue(createString()); } boolean setTabItemFocus () { return false; } /** * 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 * @exception SWTException */ public void setImage (Image image) { checkWidget(); if ((style & SWT.SEPARATOR) != 0) return; if (image != null && image.isDisposed ()) { error (SWT.ERROR_INVALID_ARGUMENT); } this.image = image; isImage = true; /* * Feature in Cocoa. If the NSImage object being set into the view is * the same NSImage object that is already there then the new image is * not taken. This results in the view's image not changing even if the * NSImage object's content has changed since it was last set into the * view. The workaround is to temporarily set the view's image to null * so that the new image will then be taken. */ if (image != null) { NSImage current = imageView.image (); if (current != null && current.id == image.handle.id) { imageView.setImage (null); } } imageView.setImage(image != null ? image.handle : null); ((NSBox)view).setContentView(imageView); } /** * Sets the receiver's text. *

* This method sets the widget label. The label may include * the mnemonic character and line delimiters. *

*

* 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 control that follows the label. 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 string the new text * * @exception IllegalArgumentException * @exception SWTException */ public void setText (String string) { checkWidget(); if (string == null) error (SWT.ERROR_NULL_ARGUMENT); if ((style & SWT.SEPARATOR) != 0) return; isImage = false; text = string; NSCell cell = new NSCell(textView.cell()); cell.setAttributedStringValue(createString()); ((NSBox)view).setContentView(textView); } }