| /******************************************************************************* |
| * Copyright (c) 2000, 2005 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.ui.console; |
| |
| import org.eclipse.jface.text.IDocumentPartitioner; |
| import org.eclipse.swt.custom.StyleRange; |
| |
| /** |
| * A document partitioner for a text console. |
| * <p> |
| * In addition to regular partitioner duties, a console document partitioner |
| * dicates which regions in its document are read-only and provides style ranges. |
| * </p> |
| * <p> |
| * Clients may implement this interface. |
| * </p> |
| * @see org.eclipse.ui.console.TextConsole |
| * @since 3.1 |
| */ |
| public interface IConsoleDocumentPartitioner extends IDocumentPartitioner { |
| |
| /** |
| * Returns whether this partitioner's document is read-only at the specified |
| * offset. The user is not allowed to type in read-only locations. |
| * |
| * @param offset document offset |
| * @return whether this partitioner's document is read-only at the specified |
| * offset |
| */ |
| public boolean isReadOnly(int offset); |
| |
| /** |
| * Returns style ranges for the specified region of this partitioner's document |
| * to use when rendering, or <code>null</code> if none. |
| * |
| * @param offset beginning offset for which style ranges are requested |
| * @param length the length of text for which style ranges are requested |
| * @return style ranges for the specified region of this partitioner's document |
| * to use when rendering, or <code>null</code> if none |
| */ |
| public StyleRange[] getStyleRanges(int offset, int length); |
| } |
