Class marimba.gui.ScrollingContainerWidget
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class marimba.gui.ScrollingContainerWidget

java.lang.Object
   |
   +----marimba.gui.Widget
           |
           +----marimba.gui.ContainerWidget
                   |
                   +----marimba.gui.ScrollingContainerWidget

public class ScrollingContainerWidget
extends ContainerWidget
A container with scrollbars.
Version:
1.32, 01/13/97
Author:
Arthur van Hoff

Variable Index

 o constrained
Determines whether the scrollbars should be constrained.
 o contHeight
The height of the content.
 o contWidth
The width of the content.
 o corner
This widget can leave the bottom-right corner open.
 o fillMode
Determines whether the scrollbars should be filled.
 o fillOptions
The possible options for the fillMode.
 o hdrHeight
The heigth of the header area above the container.
 o horz
The horizontal scrollbar.
 o horzmode
The mode for the horizontal scrollbar: never, optional or always.
 o horzOptions
The possible options for the horizontal scrollbar.
 o SCROLLSIZ
 o vert
The vertical scrollbar.
 o vertmode
The mode for the vertical scrollbar: never, optional or always.
 o vertOptions
The possible options for the vertical scrollbar.

Constructor Index

 o ScrollingContainerWidget()
Constructor.

Method Index

 o disable(boolean)
Disable/enable the scrollbarst, when disabling/enabling.
 o focusContent(int, int, int, int)
Scroll the content so that the given rectangle is visible.
 o getContHeight()
Get the height of the content.
 o getContWidth()
Get the width of the content.
 o getFillMode()
Check if the scrollbars are filled.
 o getFillOptions()
Get the possible options for the fillMode.
 o getHdrHeight()
Get the height of the header area above the container.
 o getHorz()
Get the horizontal scrollbar.
 o getHorzmode()
Get the mode for the horizontal scrollbar.
 o getHorzOptions()
Get the possible options for the horizontal scrollbar.
 o getProperties(PropertyList)
Get the properties.
 o getVert()
Get the vertical scrollbar.
 o getVertmode()
Get the mode for the vertical scrollbar.
 o getVertOptions()
Get the possible options for the vertical scrollbar.
 o handleEvent(Event)
Handle scroll events.
 o hasCorner()
Check if this widget leaves the bottom-right corner open.
 o isConstrained()
Check if the scrollbars are constrained.
 o layout()
Layout the container.
 o newContent()
Allocate content container.
 o newScrollbar(int)
Create a new scrollbar with all the necessary properties.
 o scrollContent(int, int)
Scroll the content to a given position, limited by contHeight and contWidth.
 o setConstrained(boolean)
Let the scrollbars be constrained or not.
 o setContentSize(int, int)
Set the size of the content
 o setContHeight(int)
Set the height of the content.
 o setContWidth(int)
Set the width of the content.
 o setCorner(boolean)
Let this widget have a corner or not.
 o setFillMode(int)
Let the scrollbars fill or not.
 o setHdrHeight(int)
Set the height of the header area above the container.
 o setHorzmode(int)
Set the mode for the horizontal scrollbar.
 o setProperties(PropertyList)
Set the properties.
 o setScrollbarModes(int, int)
Set scrollbar mode.
 o setVertmode(int)
Set the mode for the vertical scrollbar.

Variables

 o SCROLLSIZ
  public final int SCROLLSIZ
 o horzOptions
  public static Options horzOptions
The possible options for the horizontal scrollbar.
See Also:
getHorzOptions, horzmode
 o vertOptions
  public static Options vertOptions
The possible options for the vertical scrollbar.
See Also:
getVertOptions, vertmode
 o fillOptions
  public static Options fillOptions
The possible options for the fillMode.
See Also:
getFillOptions, fillMode
 o fillMode
  public int fillMode
Determines whether the scrollbars should be filled.
See Also:
getFillMode, setFillMode, fillOptions
 o constrained
  public boolean constrained
Determines whether the scrollbars should be constrained.
See Also:
isConstrained, setConstrained, constrained
 o horz
  public ScrollbarWidget horz
The horizontal scrollbar.
See Also:
getHorz
 o vert
  public ScrollbarWidget vert
The vertical scrollbar.
See Also:
getVert
 o hdrHeight
  public int hdrHeight
The heigth of the header area above the container.
See Also:
getHdrHeight, setHdrHeight
 o horzmode
  public int horzmode
The mode for the horizontal scrollbar: never, optional or always.
See Also:
getHorzmode, setHorzmode, horzOptions
 o vertmode
  public int vertmode
The mode for the vertical scrollbar: never, optional or always.
See Also:
getVertmode, setVertmode, vertOptions
 o contWidth
  public int contWidth
The width of the content.
See Also:
getContWidth, setContWidth
 o contHeight
  public int contHeight
The height of the content.
See Also:
getContHeight, setContHeight
 o corner
  public boolean corner
This widget can leave the bottom-right corner open. That means that the vertical scrollbar becomes smaller.
See Also:
hasCorner, setCorner

Constructors

 o ScrollingContainerWidget
  public ScrollingContainerWidget()
Constructor.

Methods

 o getProperties
  public void getProperties(PropertyList list)
Get the properties.
Overrides:
getProperties in class Widget
 o setProperties
  public void setProperties(PropertyList list)
Set the properties.
Overrides:
setProperties in class ContainerWidget
 o disable
  public void disable(boolean disabled)
Disable/enable the scrollbarst, when disabling/enabling.
Overrides:
disable in class Widget
 o getHorzOptions
  public Options getHorzOptions()
Get the possible options for the horizontal scrollbar.
See Also:
horzOptions
 o getVertOptions
  public Options getVertOptions()
Get the possible options for the vertical scrollbar.
See Also:
vertOptions
 o getFillOptions
  public Options getFillOptions()
Get the possible options for the fillMode.
See Also:
fillOptions
 o getFillMode
  public int getFillMode()
Check if the scrollbars are filled.
See Also:
fillMode
 o setFillMode
  public void setFillMode(int fillMode)
Let the scrollbars fill or not.
See Also:
fillMode
 o isConstrained
  public boolean isConstrained()
Check if the scrollbars are constrained.
See Also:
constrained
 o setConstrained
  public void setConstrained(boolean constrained)
Let the scrollbars be constrained or not.
See Also:
constrained
 o getHorz
  public ScrollbarWidget getHorz()
Get the horizontal scrollbar.
See Also:
horz
 o getVert
  public ScrollbarWidget getVert()
Get the vertical scrollbar.
See Also:
vert
 o getHdrHeight
  public int getHdrHeight()
Get the height of the header area above the container.
See Also:
hdrHeight
 o setHdrHeight
  public void setHdrHeight(int hdrHeight)
Set the height of the header area above the container.
See Also:
hdrHeight
 o getHorzmode
  public int getHorzmode()
Get the mode for the horizontal scrollbar.
See Also:
horzmode
 o setHorzmode
  public void setHorzmode(int horzmode)
Set the mode for the horizontal scrollbar.
See Also:
horzmode
 o getVertmode
  public int getVertmode()
Get the mode for the vertical scrollbar.
See Also:
vertmode
 o setVertmode
  public void setVertmode(int vertmode)
Set the mode for the vertical scrollbar.
See Also:
vertmode
 o getContWidth
  public int getContWidth()
Get the width of the content.
See Also:
contWidth
 o setContWidth
  public void setContWidth(int contWidth)
Set the width of the content.
See Also:
contWidth
 o getContHeight
  public int getContHeight()
Get the height of the content.
See Also:
contHeight
 o setContHeight
  public void setContHeight(int contHeight)
Set the height of the content.
See Also:
contHeight
 o hasCorner
  public boolean hasCorner()
Check if this widget leaves the bottom-right corner open.
See Also:
corner
 o setCorner
  public void setCorner(boolean corner)
Let this widget have a corner or not.
See Also:
corner
 o newContent
  protected Widget newContent()
Allocate content container.
Overrides:
newContent in class ContainerWidget
 o scrollContent
  public void scrollContent(int tx,
                            int ty)
Scroll the content to a given position, limited by contHeight and contWidth. This will change the translation of the content.
 o focusContent
  public void focusContent(int x,
                           int y,
                           int w,
                           int h)
Scroll the content so that the given rectangle is visible.
 o setContentSize
  public void setContentSize(int contWidth,
                             int contHeight)
Set the size of the content
 o setScrollbarModes
  public void setScrollbarModes(int horzmode,
                                int vertmode)
Set scrollbar mode.
 o newScrollbar
  public ScrollbarWidget newScrollbar(int orientation)
Create a new scrollbar with all the necessary properties.
 o layout
  public void layout()
Layout the container.
Overrides:
layout in class ContainerWidget
 o handleEvent
  public boolean handleEvent(Event evt)
Handle scroll events.
Overrides:
handleEvent in class Widget

All Packages  Class Hierarchy  This Package  Previous  Next  Index