io.github.albertus82.jface.console.StyledTextConsole Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jface-utils Show documentation
Java SWT/JFace Utility Library including a Preferences Framework, Lightweight HTTP Server and macOS support.
There is a newer version: 20.1.0
package io.github.albertus82.jface.console;

import org.eclipse.swt.SWT;
import org.eclipse.swt.custom.ST;
import org.eclipse.swt.custom.StyledText;
import org.eclipse.swt.events.KeyAdapter;
import org.eclipse.swt.events.KeyEvent;
import org.eclipse.swt.events.MenuDetectEvent;
import org.eclipse.swt.events.MenuDetectListener;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Menu;
import org.eclipse.swt.widgets.MenuItem;

import io.github.albertus82.jface.JFaceMessages;
import io.github.albertus82.jface.SwtUtils;

public class StyledTextConsole extends ScrollableConsole {

	public static final int DEFAULT_LIMIT = 100000;

	protected static final int MARGIN = 4;

	private final StringBuilder charBuffer = new StringBuilder();

	private Menu contextMenu;
	private MenuItem copyMenuItem;
	private MenuItem selectAllMenuItem;
	private MenuItem clearMenuItem;

	public StyledTextConsole(final Composite parent, final Object layoutData, final boolean redirectSystemStreams) {
		super(parent, layoutData, redirectSystemStreams);
	}

	@Override
	protected StyledText createScrollable(final Composite parent) {
		final StyledText styledText = new StyledText(parent, SWT.BORDER | SWT.READ_ONLY | SWT.V_SCROLL | SWT.H_SCROLL);
		configureStyledText(styledText);
		return styledText;
	}

	protected void configureStyledText(final StyledText styledText) {
		styledText.setMargins(MARGIN, MARGIN, MARGIN, MARGIN); // like the Text control
		createContextMenu(styledText);
	}

	protected void createContextMenu(final StyledText styledText) {
		contextMenu = new Menu(styledText);

		copyMenuItem = createCopyMenuItem(styledText);

		new MenuItem(contextMenu, SWT.SEPARATOR);

		selectAllMenuItem = createSelectAllMenuItem(styledText);

		new MenuItem(contextMenu, SWT.SEPARATOR);

		clearMenuItem = createClearMenuItem();

		styledText.addMenuDetectListener(new MenuDetectListener() {
			@Override
			public void menuDetected(final MenuDetectEvent mde) {
				final boolean notEmpty = !isEmpty();
				selectAllMenuItem.setEnabled(notEmpty);
				clearMenuItem.setEnabled(notEmpty);
				copyMenuItem.setEnabled(styledText.getSelectionCount() > 0);
			}
		});
		styledText.setMenu(contextMenu);
	}

	protected MenuItem createClearMenuItem() {
		final MenuItem clear = new MenuItem(contextMenu, SWT.PUSH);
		clear.setText(JFaceMessages.get("lbl.menu.item.clear"));
		clear.addSelectionListener(new SelectionAdapter() {
			@Override
			public void widgetSelected(final SelectionEvent se) {
				clear();
			}
		});
		return clear;
	}

	protected MenuItem createSelectAllMenuItem(final StyledText styledText) {
		final MenuItem selectAll = new MenuItem(contextMenu, SWT.PUSH);
		selectAll.setText(JFaceMessages.get("lbl.menu.item.select.all") + SwtUtils.getMod1ShortcutLabel(SwtUtils.KEY_SELECT_ALL));
		selectAll.addSelectionListener(new SelectionAdapter() {
			@Override
			public void widgetSelected(final SelectionEvent se) {
				styledText.invokeAction(ST.SELECT_ALL);
			}
		});
		styledText.addKeyListener(new KeyAdapter() {
			@Override
			public void keyPressed(final KeyEvent ke) {
				if (ke.stateMask == SWT.MOD1 && ke.keyCode == SwtUtils.KEY_SELECT_ALL) {
					styledText.invokeAction(ST.SELECT_ALL);
				}
			}
		});
		return selectAll;
	}

	protected MenuItem createCopyMenuItem(final StyledText styledText) {
		final MenuItem copy = new MenuItem(contextMenu, SWT.PUSH);
		copy.setText(JFaceMessages.get("lbl.menu.item.copy") + SwtUtils.getMod1ShortcutLabel(SwtUtils.KEY_COPY));
		copy.addSelectionListener(new SelectionAdapter() {
			@Override
			public void widgetSelected(final SelectionEvent se) {
				styledText.invokeAction(ST.COPY);
			}
		});
		return copy;
	}

	@Override
	public void clear() {
		scrollable.setText("");
	}

	@Override
	public boolean isEmpty() {
		return scrollable == null || scrollable.isDisposed() || scrollable.getCharCount() == 0;
	}

	@Override
	public boolean hasSelection() {
		return scrollable != null && !scrollable.isDisposed() && scrollable.getSelectionCount() > 0;
	}

	@Override
	protected int getDefaultLimit() {
		return DEFAULT_LIMIT;
	}

	@Override
	protected void doPrint(final String value, final int maxChars) {
		charBuffer.setLength(0);
		charBuffer.append(scrollable.getText());

		int replaceLength = 0;
		while (charBuffer.length() + value.length() > maxChars) {
			final int indexOfNewLine = charBuffer.indexOf(newLine);
			if (indexOfNewLine != -1) {
				final int replaceEnd = indexOfNewLine + newLine.length();
				replaceLength += replaceEnd;
				charBuffer.replace(0, replaceEnd, "");
			}
			else {
				replaceLength = -1;
				break;
			}
		}

		if (replaceLength >= 0) {
			if (replaceLength != 0) {
				scrollable.replaceTextRange(0, replaceLength, "");
			}
			scrollable.append(value);
		}
		else {
			scrollable.setText(value);
		}
		scrollable.setTopPixel((scrollable.getLineCount() - 1) * scrollable.getLineHeight());
	}

	protected Menu getContextMenu() {
		return contextMenu;
	}

	protected void setContextMenu(final Menu contextMenu) {
		this.contextMenu = contextMenu;
	}

	protected MenuItem getCopyMenuItem() {
		return copyMenuItem;
	}

	protected void setCopyMenuItem(final MenuItem copyMenuItem) {
		this.copyMenuItem = copyMenuItem;
	}

	protected MenuItem getSelectAllMenuItem() {
		return selectAllMenuItem;
	}

	protected void setSelectAllMenuItem(final MenuItem selectAllMenuItem) {
		this.selectAllMenuItem = selectAllMenuItem;
	}

	protected MenuItem getClearMenuItem() {
		return clearMenuItem;
	}

	protected void setClearMenuItem(final MenuItem clearMenuItem) {
		this.clearMenuItem = clearMenuItem;
	}

}