org.eclipse.swt.graphics.LineAttributes.java Source code

Introduction

Here is the source code for org.eclipse.swt.graphics.LineAttributes.java

Source

/*******************************************************************************
 * Copyright (c) 2000, 2007 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.graphics;

import org.eclipse.swt.*;

/**
 * <code>LineAttributes</code> defines a set of line attributes that
 * can be modified in a GC.
 * <p>
 * Application code does <em>not</em> need to explicitly release the
 * resources managed by each instance when those instances are no longer
 * required, and thus no <code>dispose()</code> method is provided.
 * </p>
 * 
 * @see GC#getLineAttributes()
 * @see GC#setLineAttributes(LineAttributes)
 *  
 * @since 3.3
 */
public class LineAttributes {

    /**
     * The line width.
     */
    public float width;

    /**
     * The line style.
     * 
     * @see org.eclipse.swt.SWT#LINE_CUSTOM
     * @see org.eclipse.swt.SWT#LINE_DASH
     * @see org.eclipse.swt.SWT#LINE_DASHDOT
     * @see org.eclipse.swt.SWT#LINE_DASHDOTDOT
     * @see org.eclipse.swt.SWT#LINE_DOT
     * @see org.eclipse.swt.SWT#LINE_SOLID
     */
    public int style;

    /**
     * The line cap style.
     * 
     * @see org.eclipse.swt.SWT#CAP_FLAT
     * @see org.eclipse.swt.SWT#CAP_ROUND
     * @see org.eclipse.swt.SWT#CAP_SQUARE
     */
    public int cap;

    /**
     * The line join style.
     * 
     * @see org.eclipse.swt.SWT#JOIN_BEVEL
     * @see org.eclipse.swt.SWT#JOIN_MITER
     * @see org.eclipse.swt.SWT#JOIN_ROUND
     */
    public int join;

    /**
     * The line dash style for SWT.LINE_CUSTOM.
     */
    public float[] dash;

    /**
     * The line dash style offset for SWT.LINE_CUSTOM.
     */
    public float dashOffset;

    /**
     * The line miter limit.
     */
    public float miterLimit;

    /** 
     * Create a new line attributes with the specified line width.
     *
     * @param width the line width
     */
    public LineAttributes(float width) {
        this(width, SWT.CAP_FLAT, SWT.JOIN_MITER, SWT.LINE_SOLID, null, 0, 10);
    }

    /** 
     * Create a new line attributes with the specified line cap, join and width.
     *
     * @param width the line width
     * @param cap the line cap style
     * @param join the line join style
     */
    public LineAttributes(float width, int cap, int join) {
        this(width, cap, join, SWT.LINE_SOLID, null, 0, 10);
    }

    /** 
     * Create a new line attributes with the specified arguments.
     *
     * @param width the line width
     * @param cap the line cap style
     * @param join the line join style
     * @param style the line style
     * @param dash the line dash style
     * @param dashOffset the line dash style offset
     * @param miterLimit the line miter limit
     */
    public LineAttributes(float width, int cap, int join, int style, float[] dash, float dashOffset,
            float miterLimit) {
        this.width = width;
        this.cap = cap;
        this.join = join;
        this.style = style;
        this.dash = dash;
        this.dashOffset = dashOffset;
        this.miterLimit = miterLimit;
    }
}