+++ /dev/null
-/*
- * Jexer - Java Text User Interface
- *
- * The MIT License (MIT)
- *
- * Copyright (C) 2017 Kevin Lamonte
- *
- * Permission is hereby granted, free of charge, to any person obtaining a
- * copy of this software and associated documentation files (the "Software"),
- * to deal in the Software without restriction, including without limitation
- * the rights to use, copy, modify, merge, publish, distribute, sublicense,
- * and/or sell copies of the Software, and to permit persons to whom the
- * Software is furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
- * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
- * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
- * DEALINGS IN THE SOFTWARE.
- *
- * @author Kevin Lamonte [kevin.lamonte@gmail.com]
- * @version 1
- */
-package jexer;
-
-import jexer.event.TMouseEvent;
-import jexer.event.TResizeEvent;
-
-/**
- * TScrollableWindow is a convenience superclass for windows that have
- * scrollbars.
- */
-public class TScrollableWindow extends TWindow implements Scrollable {
-
- // ------------------------------------------------------------------------
- // Variables --------------------------------------------------------------
- // ------------------------------------------------------------------------
-
- /**
- * The horizontal scrollbar.
- */
- protected THScroller hScroller = null;
-
- /**
- * The vertical scrollbar.
- */
- protected TVScroller vScroller = null;
-
- // ------------------------------------------------------------------------
- // Constructors -----------------------------------------------------------
- // ------------------------------------------------------------------------
-
- /**
- * Public constructor. Window will be located at (0, 0).
- *
- * @param application TApplication that manages this window
- * @param title window title, will be centered along the top border
- * @param width width of window
- * @param height height of window
- */
- public TScrollableWindow(final TApplication application, final String title,
- final int width, final int height) {
-
- super(application, title, width, height);
- }
-
- /**
- * Public constructor. Window will be located at (0, 0).
- *
- * @param application TApplication that manages this window
- * @param title window title, will be centered along the top border
- * @param width width of window
- * @param height height of window
- * @param flags bitmask of RESIZABLE, CENTERED, or MODAL
- */
- public TScrollableWindow(final TApplication application, final String title,
- final int width, final int height, final int flags) {
-
- super(application, title, width, height, flags);
- }
-
- /**
- * Public constructor.
- *
- * @param application TApplication that manages this window
- * @param title window title, will be centered along the top border
- * @param x column relative to parent
- * @param y row relative to parent
- * @param width width of window
- * @param height height of window
- */
- public TScrollableWindow(final TApplication application, final String title,
- final int x, final int y, final int width, final int height) {
-
- super(application, title, x, y, width, height);
- }
-
- /**
- * Public constructor.
- *
- * @param application TApplication that manages this window
- * @param title window title, will be centered along the top border
- * @param x column relative to parent
- * @param y row relative to parent
- * @param width width of window
- * @param height height of window
- * @param flags mask of RESIZABLE, CENTERED, or MODAL
- */
- public TScrollableWindow(final TApplication application, final String title,
- final int x, final int y, final int width, final int height,
- final int flags) {
-
- super(application, title, x, y, width, height, flags);
- }
-
- // ------------------------------------------------------------------------
- // TWindow ----------------------------------------------------------------
- // ------------------------------------------------------------------------
-
- /**
- * Handle window/screen resize events.
- *
- * @param event resize event
- */
- @Override
- public void onResize(final TResizeEvent event) {
- if (event.getType() == TResizeEvent.Type.WIDGET) {
- reflowData();
- placeScrollbars();
- return;
- } else {
- super.onResize(event);
- }
- }
-
- /**
- * Maximize window.
- */
- @Override
- public void maximize() {
- super.maximize();
- placeScrollbars();
- }
-
- /**
- * Restore (unmaximize) window.
- */
- @Override
- public void restore() {
- super.restore();
- placeScrollbars();
- }
-
- // ------------------------------------------------------------------------
- // TScrollableWindow ------------------------------------------------------
- // ------------------------------------------------------------------------
-
- /**
- * Place the scrollbars on the edge of this widget, and adjust bigChange
- * to match the new size. This is called by onResize().
- */
- protected void placeScrollbars() {
- if (hScroller != null) {
- hScroller.setY(getHeight() - 2);
- hScroller.setWidth(getWidth() - hScroller.getX() - 3);
- hScroller.setBigChange(getWidth() - hScroller.getX() - 3);
- }
- if (vScroller != null) {
- vScroller.setX(getWidth() - 2);
- vScroller.setHeight(getHeight() - 2);
- vScroller.setBigChange(getHeight() - 2);
- }
- }
-
- /**
- * Recompute whatever data is displayed by this widget.
- */
- public void reflowData() {
- // Default: nothing to do
- }
-
- /**
- * Get the horizontal scrollbar, or null if this Viewport does not
- * support horizontal scrolling.
- *
- * @return the horizontal scrollbar
- */
- public THScroller getHorizontalScroller() {
- return hScroller;
- }
-
- /**
- * Get the vertical scrollbar, or null if this Viewport does not support
- * vertical scrolling.
- *
- * @return the vertical scrollbar
- */
- public TVScroller getVerticalScroller() {
- return vScroller;
- }
-
- /**
- * Get the value that corresponds to being on the top edge of the
- * vertical scroll bar.
- *
- * @return the scroll value
- */
- public int getTopValue() {
- if (vScroller == null) {
- return 0;
- } else {
- return vScroller.getTopValue();
- }
- }
-
- /**
- * Set the value that corresponds to being on the top edge of the
- * vertical scroll bar.
- *
- * @param topValue the new scroll value
- */
- public void setTopValue(final int topValue) {
- if (vScroller == null) {
- return;
- } else {
- vScroller.setTopValue(topValue);
- }
- }
-
- /**
- * Get the value that corresponds to being on the bottom edge of the
- * vertical scroll bar.
- *
- * @return the scroll value
- */
- public int getBottomValue() {
- if (vScroller == null) {
- return 0;
- } else {
- return vScroller.getBottomValue();
- }
- }
-
- /**
- * Set the value that corresponds to being on the bottom edge of the
- * vertical scroll bar.
- *
- * @param bottomValue the new scroll value
- */
- public void setBottomValue(final int bottomValue) {
- if (vScroller == null) {
- return;
- } else {
- vScroller.setBottomValue(bottomValue);
- }
- }
-
- /**
- * Get current value of the vertical scroll.
- *
- * @return the scroll value
- */
- public int getVerticalValue() {
- if (vScroller == null) {
- return 0;
- } else {
- return vScroller.getValue();
- }
- }
-
- /**
- * Set current value of the vertical scroll.
- *
- * @param value the new scroll value
- */
- public void setVerticalValue(final int value) {
- if (vScroller == null) {
- return;
- } else {
- vScroller.setValue(value);
- }
- }
-
- /**
- * Get the increment for clicking on an arrow on the vertical scrollbar.
- *
- * @return the increment value
- */
- public int getVerticalSmallChange() {
- if (vScroller == null) {
- return 0;
- } else {
- return vScroller.getSmallChange();
- }
- }
-
- /**
- * Set the increment for clicking on an arrow on the vertical scrollbar.
- *
- * @param smallChange the new increment value
- */
- public void setVerticalSmallChange(final int smallChange) {
- if (vScroller == null) {
- return;
- } else {
- vScroller.setSmallChange(smallChange);
- }
- }
-
- /**
- * Get the increment for clicking in the bar between the box and an
- * arrow on the vertical scrollbar.
- *
- * @return the increment value
- */
- public int getVerticalBigChange() {
- if (vScroller == null) {
- return 0;
- } else {
- return vScroller.getBigChange();
- }
- }
-
- /**
- * Set the increment for clicking in the bar between the box and an
- * arrow on the vertical scrollbar.
- *
- * @param bigChange the new increment value
- */
- public void setVerticalBigChange(final int bigChange) {
- if (vScroller == null) {
- return;
- } else {
- vScroller.setBigChange(bigChange);
- }
- }
-
- /**
- * Perform a small step change up.
- */
- public void verticalDecrement() {
- if (vScroller == null) {
- return;
- } else {
- vScroller.decrement();
- }
- }
-
- /**
- * Perform a small step change down.
- */
- public void verticalIncrement() {
- if (vScroller == null) {
- return;
- } else {
- vScroller.increment();
- }
- }
-
- /**
- * Perform a big step change up.
- */
- public void bigVerticalDecrement() {
- if (vScroller == null) {
- return;
- } else {
- vScroller.bigDecrement();
- }
- }
-
- /**
- * Perform a big step change down.
- */
- public void bigVerticalIncrement() {
- if (vScroller == null) {
- return;
- } else {
- vScroller.bigIncrement();
- }
- }
-
- /**
- * Go to the top edge of the vertical scroller.
- */
- public void toTop() {
- if (vScroller == null) {
- return;
- } else {
- vScroller.toTop();
- }
- }
-
- /**
- * Go to the bottom edge of the vertical scroller.
- */
- public void toBottom() {
- if (vScroller == null) {
- return;
- } else {
- vScroller.toBottom();
- }
- }
-
- /**
- * Get the value that corresponds to being on the left edge of the
- * horizontal scroll bar.
- *
- * @return the scroll value
- */
- public int getLeftValue() {
- if (hScroller == null) {
- return 0;
- } else {
- return hScroller.getLeftValue();
- }
- }
-
- /**
- * Set the value that corresponds to being on the left edge of the
- * horizontal scroll bar.
- *
- * @param leftValue the new scroll value
- */
- public void setLeftValue(final int leftValue) {
- if (hScroller == null) {
- return;
- } else {
- hScroller.setLeftValue(leftValue);
- }
- }
-
- /**
- * Get the value that corresponds to being on the right edge of the
- * horizontal scroll bar.
- *
- * @return the scroll value
- */
- public int getRightValue() {
- if (hScroller == null) {
- return 0;
- } else {
- return hScroller.getRightValue();
- }
- }
-
- /**
- * Set the value that corresponds to being on the right edge of the
- * horizontal scroll bar.
- *
- * @param rightValue the new scroll value
- */
- public void setRightValue(final int rightValue) {
- if (hScroller == null) {
- return;
- } else {
- hScroller.setRightValue(rightValue);
- }
- }
-
- /**
- * Get current value of the horizontal scroll.
- *
- * @return the scroll value
- */
- public int getHorizontalValue() {
- if (hScroller == null) {
- return 0;
- } else {
- return hScroller.getValue();
- }
- }
-
- /**
- * Set current value of the horizontal scroll.
- *
- * @param value the new scroll value
- */
- public void setHorizontalValue(final int value) {
- if (hScroller == null) {
- return;
- } else {
- hScroller.setValue(value);
- }
- }
-
- /**
- * Get the increment for clicking on an arrow on the horizontal
- * scrollbar.
- *
- * @return the increment value
- */
- public int getHorizontalSmallChange() {
- if (hScroller == null) {
- return 0;
- } else {
- return hScroller.getSmallChange();
- }
- }
-
- /**
- * Set the increment for clicking on an arrow on the horizontal
- * scrollbar.
- *
- * @param smallChange the new increment value
- */
- public void setHorizontalSmallChange(final int smallChange) {
- if (hScroller == null) {
- return;
- } else {
- hScroller.setSmallChange(smallChange);
- }
- }
-
- /**
- * Get the increment for clicking in the bar between the box and an
- * arrow on the horizontal scrollbar.
- *
- * @return the increment value
- */
- public int getHorizontalBigChange() {
- if (hScroller == null) {
- return 0;
- } else {
- return hScroller.getBigChange();
- }
- }
-
- /**
- * Set the increment for clicking in the bar between the box and an
- * arrow on the horizontal scrollbar.
- *
- * @param bigChange the new increment value
- */
- public void setHorizontalBigChange(final int bigChange) {
- if (hScroller == null) {
- return;
- } else {
- hScroller.setBigChange(bigChange);
- }
- }
-
- /**
- * Perform a small step change left.
- */
- public void horizontalDecrement() {
- if (hScroller == null) {
- return;
- } else {
- hScroller.decrement();
- }
- }
-
- /**
- * Perform a small step change right.
- */
- public void horizontalIncrement() {
- if (hScroller == null) {
- return;
- } else {
- hScroller.increment();
- }
- }
-
- /**
- * Perform a big step change left.
- */
- public void bigHorizontalDecrement() {
- if (hScroller == null) {
- return;
- } else {
- hScroller.bigDecrement();
- }
- }
-
- /**
- * Perform a big step change right.
- */
- public void bigHorizontalIncrement() {
- if (hScroller == null) {
- return;
- } else {
- hScroller.bigIncrement();
- }
- }
-
- /**
- * Go to the left edge of the horizontal scroller.
- */
- public void toLeft() {
- if (hScroller == null) {
- return;
- } else {
- hScroller.toLeft();
- }
- }
-
- /**
- * Go to the right edge of the horizontal scroller.
- */
- public void toRight() {
- if (hScroller == null) {
- return;
- } else {
- hScroller.toRight();
- }
- }
-
- /**
- * Go to the top-left edge of the horizontal and vertical scrollers.
- */
- public void toHome() {
- if (hScroller != null) {
- hScroller.toLeft();
- }
- if (vScroller != null) {
- vScroller.toTop();
- }
- }
-
- /**
- * Go to the bottom-right edge of the horizontal and vertical scrollers.
- */
- public void toEnd() {
- if (hScroller != null) {
- hScroller.toRight();
- }
- if (vScroller != null) {
- vScroller.toBottom();
- }
- }
-
- /**
- * Check if a mouse press/release/motion event coordinate is over the
- * vertical scrollbar.
- *
- * @param mouse a mouse-based event
- * @return whether or not the mouse is on the scrollbar
- */
- protected final boolean mouseOnVerticalScroller(final TMouseEvent mouse) {
- if (vScroller == null) {
- return false;
- }
- if ((mouse.getAbsoluteX() == vScroller.getAbsoluteX())
- && (mouse.getAbsoluteY() >= vScroller.getAbsoluteY())
- && (mouse.getAbsoluteY() < vScroller.getAbsoluteY() +
- vScroller.getHeight())
- ) {
- return true;
- }
- return false;
- }
-
- /**
- * Check if a mouse press/release/motion event coordinate is over the
- * horizontal scrollbar.
- *
- * @param mouse a mouse-based event
- * @return whether or not the mouse is on the scrollbar
- */
- protected final boolean mouseOnHorizontalScroller(final TMouseEvent mouse) {
- if (hScroller == null) {
- return false;
- }
- if ((mouse.getAbsoluteY() == hScroller.getAbsoluteY())
- && (mouse.getAbsoluteX() >= hScroller.getAbsoluteX())
- && (mouse.getAbsoluteX() < hScroller.getAbsoluteX() +
- hScroller.getWidth())
- ) {
- return true;
- }
- return false;
- }
-
-}
git://git.nikiroo.be / fanfix.git / blobdiff