ice.storm
Class DocPane

java.lang.Object
  ice.storm.DocPane

Direct Known Subclasses:

DocPaneXml

public abstract class DocPane

extends Object

Constructor Summary

DocPane()

Method Summary

boolean	canScroll(int x, int y) Determines whether it is possible to scroll to the given position.
abstract Image	createImage(int w, int h) Create an off-screen buffer suitable for rendering in this pane later
abstract boolean	doesAutoRepaint()
abstract int	getDocHeight()
abstract int	getDocWidth()
abstract int	getPaneHeight()
abstract int	getPaneWidth()
int	getScrollMaxX()
int	getScrollMaxY()
abstract int	getScrollX()
int	getScrollX(int x) Gets the valid x.
abstract int	getScrollY()
int	getScrollY(int y) Gets the valid y.
boolean	isVisibleOnScreen(int x, int y)
abstract void	reqClear() Make empty.
abstract void	reqFocus() Request focus on the top rendering container
abstract void	reqRepaint()
abstract void	reqRepaint(int x, int y, int w, int h)
abstract void	revalidate(int x, int y, int w, int h) Schedule relayout with new boundaries
abstract void	setAutoRepaint(boolean rp)
abstract void	setCursor(int type)
abstract void	setScrollPosition(int x, int y)
void	updateScrollbars(boolean isRTL)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocPane

public DocPane()

Method Detail

getDocWidth

public abstract int getDocWidth()

getDocHeight

public abstract int getDocHeight()

getScrollX

public abstract int getScrollX()

getScrollY

public abstract int getScrollY()

getPaneWidth

public abstract int getPaneWidth()

getPaneHeight

public abstract int getPaneHeight()

setScrollPosition

public abstract void setScrollPosition(int x,
                                       int y)

updateScrollbars

public void updateScrollbars(boolean isRTL)

getScrollMaxX

public final int getScrollMaxX()

getScrollMaxY

public final int getScrollMaxY()

getScrollX

public final int getScrollX(int x)

Gets the valid x.

That is:

• if the specified x is lesser than 0, 0 is returned;
• if the specified x is greater than getScrollMaxX(), getScrollMaxX() is returned;
• in the other case the specified x is returned unchanged.

Parameters:

x -

Returns:

the valid x

Since:

5.4.3

See Also:

getScrollMaxX(), getScrollY(int)

getScrollY

public final int getScrollY(int y)

Gets the valid y.

That is:

• if the specified y is lesser than 0, 0 is returned;
• if the specified y is greater than getScrollMaxY(), getScrollMaxY() is returned;
• in the other case the specified y is returned unchanged.

Parameters:

y -

Returns:

the valid y

Since:

5.4.3

See Also:

getScrollMaxY(), getScrollX(int)

isVisibleOnScreen

public final boolean isVisibleOnScreen(int x,
                                       int y)

canScroll

public final boolean canScroll(int x,
                               int y)

Determines whether it is possible to scroll to the given position.

Returns:

true if scrolling is possible, false otherwise

setAutoRepaint

public abstract void setAutoRepaint(boolean rp)

doesAutoRepaint

public abstract boolean doesAutoRepaint()

revalidate

public abstract void revalidate(int x,
                                int y,
                                int w,
                                int h)

Schedule relayout with new boundaries

reqClear

public abstract void reqClear()

Make empty. Should remove subcomponents if any

reqFocus

public abstract void reqFocus()

Request focus on the top rendering container

reqRepaint

public abstract void reqRepaint()

reqRepaint

public abstract void reqRepaint(int x,
                                int y,
                                int w,
                                int h)

setCursor

public abstract void setCursor(int type)

createImage

public abstract Image createImage(int w,
                                  int h)

Create an off-screen buffer suitable for rendering in this pane later