org.apache.pivot.wtk
Class Viewport

java.lang.Object
  org.apache.pivot.wtk.Component
      org.apache.pivot.wtk.Container
          org.apache.pivot.wtk.Viewport

All Implemented Interfaces:

Iterable<Component>, org.apache.pivot.collections.Sequence<Component>, ConstrainedVisual, Visual

Direct Known Subclasses:

Panorama, ScrollPane

@DefaultProperty(value="view")
public abstract class Viewport
extends Container

Abstract base class for viewport components. Viewports provide a windowed view on a component (called the "view") that is too large to fit within a given area. They are generally scrollable.

Nested Class Summary

static interface

Viewport.Skin Viewport skin interface.

Nested classes/interfaces inherited from class org.apache.pivot.wtk.Container

Container.EDT_Checker

Nested classes/interfaces inherited from class org.apache.pivot.wtk.Component

Component.DecoratorSequence, Component.StyleDictionary, Component.UserDataDictionary

Nested classes/interfaces inherited from interface org.apache.pivot.collections.Sequence

org.apache.pivot.collections.Sequence.Tree<T>

Constructor Summary

Viewport()

Method Summary

int	getScrollLeft()
int	getScrollTop()
Component	getView()
Bounds	getViewportBounds() The bounds of the Viewport within the container, for example, in ScrollPaneSkin, this excludes the scrollbars.
org.apache.pivot.util.ListenerList<ViewportListener>	getViewportListeners()
boolean	isConsumeRepaint() Returns the consumeRepaint flag, which controls whether the viewport will propagate repaints to its parent or consume them.
org.apache.pivot.collections.Sequence<Component>	remove(int index, int count)
void	repaint(int x, int y, int width, int height, boolean immediate) Flags an area as needing to be repainted.
void	setConsumeRepaint(boolean consumeRepaint) Sets the consumeRepaint flag, which controls whether the viewport will propagate repaints to its parent or consume them.
void	setScrollLeft(int scrollLeft)
void	setScrollTop(int scrollTop)
protected void	setSkin(Skin skin) Sets the skin, replacing any previous skin.
void	setView(Component view)

Methods inherited from class org.apache.pivot.wtk.Container

add, assertEventDispatchThread, assertEventDispatchThread, clear, containsFocus, descendantAdded, descendantGainedFocus, descendantLostFocus, descendantRemoved, get, getComponentAt, getContainerListeners, getContainerMouseListeners, getDescendantAt, getFocusTraversalPolicy, getLength, getNamedComponent, indexOf, insert, isAncestor, iterator, layout, load, mouseClick, mouseDown, mouseMove, mouseOut, mouseUp, mouseWheel, move, paint, remove, removeAll, requestFocus, setEventDispatchThreadChecker, setFocusTraversalPolicy, setParent, setVisible, store, transferFocus, update

Methods inherited from class org.apache.pivot.wtk.Component

clearFocus, contains, getAncestor, getAncestor, getAttribute, getAutomationID, getBaseline, getBaseline, getBounds, getComponentClassListeners, getComponentDataListeners, getComponentDecoratorListeners, getComponentKeyListeners, getComponentListeners, getComponentMouseButtonListeners, getComponentMouseListeners, getComponentMouseWheelListeners, getComponentStateListeners, getComponentStyleListeners, getComponentTooltipListeners, getCursor, getDecoratedBounds, getDecorators, getDisplay, getDragSource, getDropTarget, getFocusedComponent, getGraphics, getHeight, getHeightLimits, getLocation, getMaximumHeight, getMaximumWidth, getMenuHandler, getMinimumHeight, getMinimumWidth, getMouseLocation, getName, getNamedStyles, getParent, getPreferredHeight, getPreferredHeight, getPreferredSize, getPreferredWidth, getPreferredWidth, getSize, getSkin, getStyles, getTooltipDelay, getTooltipText, getTypedStyles, getUserData, getVisibleArea, getVisibleArea, getVisibleArea, getWidth, getWidthLimits, getWindow, getX, getY, indexBoundsCheck, installSkin, invalidate, isBlocked, isEnabled, isFocusable, isFocused, isMouseOver, isOpaque, isPreferredHeightSet, isPreferredSizeSet, isPreferredWidthSet, isShowing, isValid, isVisible, keyPressed, keyReleased, keyTyped, mapPointFromAncestor, mapPointFromAncestor, mapPointToAncestor, mapPointToAncestor, mouseOver, reenterMouse, repaint, repaint, repaint, repaint, repaint, scrollAreaToVisible, scrollAreaToVisible, setAttribute, setAutomationID, setCursor, setDragSource, setDropTarget, setEnabled, setFocused, setHeight, setHeightLimits, setHeightLimits, setLocation, setLocation, setMaximumHeight, setMaximumWidth, setMenuHandler, setMinimumHeight, setMinimumWidth, setName, setPreferredHeight, setPreferredSize, setPreferredSize, setPreferredWidth, setSize, setSize, setStyleName, setStyleNames, setStyleNames, setStyles, setStyles, setTooltipDelay, setTooltipText, setWidth, setWidthLimits, setWidthLimits, setX, setY, toString, transferFocus, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

Viewport

public Viewport()

Method Detail

setSkin

protected void setSkin(Skin skin)

Description copied from class: Component

Sets the skin, replacing any previous skin.

Overrides:

setSkin in class Component

Parameters:

skin - The new skin.

getScrollTop

public int getScrollTop()

setScrollTop

public void setScrollTop(int scrollTop)

getScrollLeft

public int getScrollLeft()

setScrollLeft

public void setScrollLeft(int scrollLeft)

getView

public Component getView()

setView

public void setView(Component view)

isConsumeRepaint

public boolean isConsumeRepaint()

Returns the consumeRepaint flag, which controls whether the viewport will propagate repaints to its parent or consume them. This flag enables skins to optimize viewport scrolling by blitting the display to reduce the required repaint area.

Returns:

true if this viewport will consume repaints that bubble up through it; false if it will propagate them up like normal.

setConsumeRepaint

public void setConsumeRepaint(boolean consumeRepaint)

Sets the consumeRepaint flag, which controls whether the viewport will propagate repaints to its parent or consume them. This flag enables skins to optimize viewport scrolling by blitting the display to reduce the required repaint area.

Parameters:

consumeRepaint - true to consume repaints that bubble up through this viewport; false to propagate them up like normal.

getViewportBounds

public Bounds getViewportBounds()

The bounds of the Viewport within the container, for example, in ScrollPaneSkin, this excludes the scrollbars.

repaint

public void repaint(int x,
                    int y,
                    int width,
                    int height,
                    boolean immediate)

Description copied from class: Component

Flags an area as needing to be repainted.

Overrides:

repaint in class Component

remove

public org.apache.pivot.collections.Sequence<Component> remove(int index,
                                                               int count)

Specified by:

remove in interface org.apache.pivot.collections.Sequence<Component>

Overrides:

remove in class Container

getViewportListeners

public org.apache.pivot.util.ListenerList<ViewportListener> getViewportListeners()