Class UIScrollViewer

public class UIScrollViewer extends UIPanel implements 
            IUIPosition
{
  // Fields
  public final static int CONT;
  public final static Integer CONTENT;
  public final static int H_CORNER;
  public final static int H_HORZ;
  public final static int H_VERT;
  public final static int HEADER_BOTTOM;
  public final static Integer HEADER_CORNER;
  public final static Integer HEADER_HORZ;
  public final static int HEADER_RIGHT;
  public final static Integer HEADER_VERT;
  public final static int S_CORNER;
  public final static int S_HORZ;
  public final static int S_VERT;
  public final static Integer SCROLL_CORNER;
  public final static Integer SCROLL_HORZ;
  public final static int SCROLL_LEFT;
  public final static int SCROLL_TOP;
  public final static Integer SCROLL_VERT;

  // Constructors
  public UIScrollViewer();
  public UIScrollViewer(IUIComponent comp);
  public UIScrollViewer(IUIComponent comp, int style);
  public UIScrollViewer(IUIComponent comp, int hLine, int vLine);
  public UIScrollViewer(IUIComponent comp, int hLine, int vLine,
        int style);
  public UIScrollViewer(IUIComponent comp, int hLine, int vLine,
        int style, int scrollStyle);
  public UIScrollViewer(IUIComponent comp, int hLine, int vLine,
        int style, int hstyle, int vstyle);

  // Methods
  public IUIComponent add(IUIComponent comp, Object constraints,
        int index);
  public void addNotify();
  public boolean ensureVisible(Rectangle rect);
  public IUIComponent getContent();
  public int getHLine();
  public IUIComponent getLayoutComponent(Object constraints);
  public Point getLine();
  public Dimension getMinimumSize();
  public Point getPosition();
  public Dimension getPreferredSize();
  public int getRoleCode();
  public int getVLine();
  public int getXPosition();
  public int getYPosition();
  public boolean handleEvent(Event e);
  public boolean isKeyable();
  public boolean keyDown(Event e, int key);
  public void layout();
  public void remove(IUIComponent comp);
  public IUIComponent replace(IUIComponent comp,
        Object constraints);
  public void requestFocus();
  public void setContent(IUIComponent content);
  public void setHLine(int line);
  public void setLine(int hLine, int vLine);
  public void setPosition(Point pt);
  public void setPosition(int x, int y);
  public void setScrollStyle(int scroller, int style);
  public void setScrollStyle(int style);
  public void setVLine(int line);
  public void setXPosition(int x);
  public void setYPosition(int y);
}

This class implements a scroll viewer control.

Typically, UIScrollViewer uses a UIViewer object for content, which displays another component. The scroll viewer control also displays other components, such as scroll bars and header bars. Note Content objects besides UIViewer objects are not fully supported (even when they implement the IUIPosition interface.

When creating a UIScrollViewer object, you specify the content component, optional scroll line increments, and optional style flags. You can pass any bitwise combination of the following flags for the scroll viewer's style.

Scroll Viewer Style	Description
SCROLL_TOP	Places the horizontal scroll bar on the top of the scroll viewer panel. The default position is on the bottom.
SCROLL_LEFT	Places the vertical scroll bar on the left side of the scroll viewer panel. The default position is on the right.
HEADER_BOTTOM	Places the horizontal header bar on the bottom of the scroll viewer panel. The default position is on the top.
HEADER_RIGHT	Places the vertical header bar on the right side of the scroll viewer panel. The default position is on the left.

The following example shows several ways of constructing UIScrollViewer objects.

// Construct a scroll viewer that displays the graphical
// image stored in the variable myImage. Accept the default 
// scroll line increments and the default style.
UIScrollViewer sv1 = new UIScrollViewer(new UIGraphic(myImage));

// Construct a scroll viewer that displays the UIList
// object myList. Specify scroll line increments of
// 15 pixels. Position the horizontal scroll bar on 
// the top of the scroll viewer panel.
UIScrollViewer sv2 = 
   new UIScrollViewer(myList, 15, 15, UIScrollViewer.SCROLL_TOP);

// Now add sv1 and sv2 to the container.
add(sv1);
add(sv2);

You can also specify a style for each scroll bar. The following flags define valid scroll bar styles.

Scroll Bar Style	Description
UIScroll.NOHIDE	Always displays the scroll bar; the scroll bar is disabled if it is not needed. By default, scroll bars are displayed only when necessary.
UIScroll.NOSHOW	Always hides the scroll bar. By default, scroll bars are displayed only when necessary. Use this in place of removing the scroll bars.
UIScroll.NONPROPORTIONAL	The size of the scroll bar's thumb component is not proportional to the scroll bar's range.

Note By default, each scroll bar has the UIScroll.NOKEY style set; therefore, the scroll bars cannot receive keyboard input.

The following example shows how to construct a UIScrollViewer object with scroll bar styles. You can specify a style for both scroll bars in one parameter, or you can specify a separate style for each scroll bar in two parameters.

// Construct a scroll viewer that displays the UITree
// object myTree1. Always show both scroll bars.
UIScrollViewer sv3 = 
   new UIScrollViewer(myTree1, 15, 15, UIScrollViewer.SCROLL_TOP,
                      UIScroll.NOHIDE);

// Construct a scroll viewer that displays the UITree
// object myTree2. Always show the horizontal scroll 
// bar and always hide the vertical scroll bar.
UIScrollViewer sv4 = 
   new UIScrollViewer(myTree2, 15, 15, UIScrollViewer.SCROLL_TOP, 
                      UIScroll.NOHIDE, UIScroll.NOSHOW);

// Add sv3 and sv4 to the container.
add(sv3);
add(sv4);

When a UIScrollViewer object is created, it contains only content and scroll bar components. To add other components, or replace existing components, call the add method. Each type of component that can be displayed is identified by a constraint, described by the following table.

Constraint Object	Component
CONTENT	The content component.
SCROLL_HORZ	The horizontal scroll bar (by default, a UIScrollBar object).
SCROLL_VERT	The vertical scroll bar (by default, a UIScrollBar object).
SCROLL_CORNER	The corner component between the scroll bars.
HEADER_HORZ	The horizontal header bar.
HEADER_VERT	The vertical header bar.
HEADER_CORNER	The corner component between the header bars.

Note The SCROLL_HORZ and SCROLL_VERT components must implement the IUIScroll interface; otherwise, they cannot be added. The CONTENT, HEADER_HORZ, and HEADER_VERT components must implement IUIPosition. If they do not, add first converts them to UIViewer objects before adding them to the scroll viewer control.

To set the scroll viewer's content, you can also call the setContent method, which returns the previous content component. The following example shows how to add (or replace) components.

// Construct a scroll viewer that displays the UIList
// object myList. When a UIScrollViewer object is created, 
// the content is first added to a UIViewer object, which 
// is then added to the scroll viewer.
UIScrollViewer sv = new UIScrollViewer(myList);
add(sv);  // Add sv to the container.

// Now add the UIHeaderRow object myHeader to sv as
// a horizontal header bar.
sv.add(UIScrollViewer.HEADER_HORZ, myHeader);

// Replace the content in sv with the UITree object myTree.
sv.add(UIScrollViewer.CONTENT, myTree);

// Call setContent to replace the content in sv with the
// graphical image stored in myImage. Save the previous content 
// component in the variable oldContents. 
IUIComponent oldContents = sv.setContent(new UIGraphic(myImage));

The UIColumnViewer class extends UIScrollViewer to display a set of columns inside the viewer control. UIColumnViewer automatically adds a UIHeaderRow object as the HEADER_HORZ component.

UIComponent
  |
  +--UIContainer
    |
    +--UIStateContainer
      |
      +--UIPanel
        |
        +--UIScrollViewer

Constructors

UIScrollViewer

public UIScrollViewer();

Creates a scroll viewer control with no content.

Remarks:

To add a content component to the control, call add or setContent. The control displays scroll bars only when they are needed to view the content component. The content component's horizontal and vertical scroll line increments are 10 pixels each.

By default, the horizontal scroll bar is placed at the bottom of the scroll viewer control. The vertical scroll bar is placed at the right. The horizontal and vertical header bars are placed at the top and at the left of the control, respectively.

UIScrollViewer

public UIScrollViewer(IUIComponent comp);

Creates a scroll viewer control with the specified component.

Parameter	Description
comp	The component to be displayed within the scroll viewer control.

Remarks:

The control displays scroll bars only when they are needed to view the content component. The content component's horizontal and vertical scroll line increments are 10 pixels each. To change the content component, call add or setContent.

By default, the horizontal scroll bar is placed at the bottom of the scroll viewer control. The vertical scroll bar is placed at the right. The horizontal and vertical header bars are placed at the top and at the left of the control, respectively.

UIScrollViewer

public UIScrollViewer(IUIComponent comp, int style);

Creates a scroll viewer control with the specified component and style.

Parameter	Description
comp	The component to be displayed within the scroll viewer control.
style	The style of the scroll viewer control. This parameter specifies where the scroll bars and header bars will be positioned. You can pass any bitwise combination of the following values: SCROLL_TOP, SCROLL_LEFT, HEADER_BOTTOM, and HEADER_RIGHT. You can also pass 0 for the default style, which places scroll bars at the bottom and at the right of the control, and places header bars at the top and at the left.

Remarks:

By default, the control displays scroll bars only when they are needed to view the content component. The content component's horizontal and vertical scroll line increments are 10 pixels each. To change the content component, call add or setContent.

Exceptions:

IllegalArgumentException if an undefined style was specified.

UIScrollViewer

public UIScrollViewer(IUIComponent comp, int hLine, int vLine);

Creates a scroll viewer control with the specified component and scroll line increments.

Parameter	Description
comp	The component to be displayed within the scroll viewer control.
hLine	The horizontal increment for scrolling the component (in pixels).
vLine	The vertical increment for scrolling the component (in pixels).

Remarks:

By default, the control displays scroll bars only when they are needed to view the content component. The horizontal scroll bar is placed at the bottom of the scroll viewer control. The vertical scroll bar is placed at the right. The horizontal and vertical header bars are placed at the top and at the left of the control, respectively.

To change the content component, call add or setContent.

UIScrollViewer

public UIScrollViewer(IUIComponent comp, int hLine, int vLine, int style);

Creates a scroll viewer control with the specified component, scroll line increments, and style.

Parameter	Description
comp	The component to be displayed within the scroll viewer control.
hLine	The horizontal increment for scrolling the component (in pixels).
vLine	The vertical increment for scrolling the component (in pixels).
style	The style of the scroll viewer control. This parameter specifies where the scroll bars and header bars will be positioned. You can pass any bitwise combination of the following values: SCROLL_TOP, SCROLL_LEFT, HEADER_BOTTOM, and HEADER_RIGHT. You can also pass 0 for the default style, which places scroll bars at the bottom and at the right of the control, and places header bars at the top and at the left.

Remarks:

By default, the control displays scroll bars only when they are needed to view the content component. To change the content component, call add or setContent.

Exceptions:

IllegalArgumentException if an undefined style was specified.

UIScrollViewer

public UIScrollViewer(IUIComponent comp, int hLine, int vLine, int style,
        int scrollStyle);

Creates a scroll viewer control with the specified component, scroll line increments, and styles.

Parameter	Description
comp	The component to be displayed within the scroll viewer control.
hLine	The horizontal increment for scrolling the component (in pixels).
vLine	The vertical increment for scrolling the component (in pixels).
style	The style of the scroll viewer control. This parameter specifies where the scroll bars and header bars will be positioned. You can pass any bitwise combination of the following values: SCROLL_TOP, SCROLL_LEFT, HEADER_BOTTOM, and HEADER_RIGHT. You can also pass 0 for the default style, which places scroll bars at the bottom and at the right of the control, and places header bars at the top and at the left.
scrollStyle	The style of both scroll bars. Possible values include UIScroll.NOHIDE, UIScroll.NOSHOW, or UIScroll.NONPROPORTIONAL.

Remarks:

To change the content component, call add or setContent.

Exceptions:

IllegalArgumentException if an undefined style was specified.

UIScrollViewer

public UIScrollViewer(IUIComponent comp, int hLine, int vLine, int style,
        int hstyle, int vstyle);

Creates a scroll viewer control with the specified component, scroll line increments, and styles.

Parameter	Description
comp	The component to be displayed within the scroll viewer control.
hLine	The horizontal increment for scrolling the component (in pixels).
vLine	The vertical increment for scrolling the component (in pixels).
style	The style of the scroll viewer control. This parameter specifies where the scroll bars and header bars will be positioned. You can pass any bitwise combination of the following values: SCROLL_TOP, SCROLL_LEFT, HEADER_BOTTOM, and HEADER_RIGHT. You can also pass 0 for the default style, which places scroll bars at the bottom and at the right of the control, and places header bars at the top and at the left.
hstyle	The style of the horizontal scroll bar. Possible values include UIScroll.NOHIDE, UIScroll.NOSHOW, or UIScroll.NONPROPORTIONAL.
vstyle	The style of the vertical scroll bar. Possible values include UIScroll.NOHIDE, UIScroll.NOSHOW, or UIScroll.NONPROPORTIONAL.

Remarks:

To change the content component, call add or setContent.

Exceptions:

IllegalArgumentException if an undefined style was specified.

Methods

add

public IUIComponent add(IUIComponent comp, Object constraints, int index);

Adds the specified component with the specified constraints. If a component already exists at this index, it is replaced with the specified component.

Return Value:

Returns the component that was added, if successful; otherwise, returns null.

Parameter	Description
comp	The component to be added.
constraints	The layout constraints identifying where to add the component. This must be one of the following constraints, or the method performs no operation and returns null. SCROLL_VERT SCROLL_HORZ SCROLL_CORNER HEADER_VERT HEADER_HORZ HEADER_CORNER CONTENT
index	The z-order index of the component to be added or replaced.

Remarks:

When adding components, the SCROLL_HORZ and SCROLL_VERT components must implement the IUIScroll interface; otherwise, they cannot be added. The CONTENT, HEADER_HORZ, and HEADER_VERT components must implement IUIPosition. If they do not, add first converts them to UIViewer objects before adding them to the scroll viewer control. To set the content, you can also call the setContent method, which returns the previous content component. For examples of how to call add and setContent, see the UIScrollViewer overview.

Overrides:

add(IUIComponent,Object,int) in UIPanel.

Exceptions:

IllegalArgumentException if an undefined constraint object was specified.

See Also: getLayoutComponent, remove

addNotify

public void addNotify();

Invokes addNotify for each component in the associated root container.

Return Value:

No return value.

See Also: removeNotify

ensureVisible

public boolean ensureVisible(Rectangle rect);

Brings the area identified by the specified rectangle into view.

Return Value:

Returns true if any component was moved or resized to make the rectangle visible; otherwise, returns false.

Parameter	Description
rect	The rectangle identifying the area to be made visible.

Remarks:

This method is called when the scroll viewer control has focus. If the entire rectangle does not fit inside the viewer control, the upper-right corner of the rectangle is favored.

getContent

public IUIComponent getContent();

Retrieves the component currently being displayed in the scroll viewer control.

Return Value:

Returns the content component. If the scroll viewer's content is a UIViewer object, the content component of the UIViewer object is returned.

Remarks:

To retrieve other components in the scroll viewer (such as scroll bars and header bars), call the getLayoutComponent method. Be aware that calling getContent is different than calling getLayoutComponent with the CONTENT index. If the scroll viewer's content is a UIViewer object, getLayoutComponent returns the UIViewer object, while getContent returns the content of the UIViewer object.

For more information about scroll viewers and their content, see the UIScrollViewer overview.

See Also: setContent

getHLine

public int getHLine();

Retrieves the number of pixels associated with a horizontal scroll position.

Return Value:

Returns the number of pixels in the horizontal scroll bar's scroll line.

See Also: getVLine, getLine, setHLine

getLayoutComponent

public IUIComponent getLayoutComponent(Object constraints);

Retrieves the component at the specified constraint.

Return Value:

Returns the specified component, if found; otherwise, returns null.

Parameter	Description
constraints	The layout constraints identifying where to add the component. This value depends on the layout manager of the underlying UI object. This must be one of the following constraints, or the method performs no operation and returns null. SCROLL_VERT SCROLL_HORZ SCROLL_CORNER HEADER_VERT HEADER_HORZ HEADER_CORNER CONTENT

Remarks:

Calling getLayoutComponent with the CONTENT constraint is different than calling getContent. If the scroll viewer's content is a UIViewer object, getLayoutComponent returns the UIViewer object, while getContent returns the content of the UIViewer object.

For more information about scroll viewers and their content, see the UIScrollViewer overview.

Exceptions:

IllegalArgumentException if an undefined constraint object was specified.

See Also: add, remove

getLine

public Point getLine();

Retrieves the number of pixels associated with the horizontal and vertical scroll positions.

Return Value:

Returns a Point object that contains the number of pixels in a scroll line. The x coordinate specifies the horizontal scroll line; the y coordinate specifies the vertical scroll line.

See Also: getHLine, getVLine, setLine

getMinimumSize

public Dimension getMinimumSize();

Retrieves the minimum size (in pixels) of the scroll viewer control. The minimum size is based on the preferred size of each component.

Return Value:

Returns a Dimension object that contains the minimum size.

See Also: getPreferredSize

getPosition

public Point getPosition();

Retrieves the current position of the scroll viewer's content.

Return Value:

Returns a Point object that contains the content component's position. The x and y coordinates specify the horizontal and vertical positions (in pixels), respectively.

Remarks:

This method implements getPosition in the IUIPosition interface.

See Also: getXPosition, getYPosition, setPosition

getPreferredSize

public Dimension getPreferredSize();

Retrieves the preferred size (in pixels) of the scroll viewer control. The preferred size is based on the preferred size of each component.

Return Value:

Returns a Dimension object that contains the preferred size (in pixels).

See Also: getMinimumSize

getRoleCode

public int getRoleCode();

Retrieves the ROLE_SYSTEM code that best describes the role of the scroll viewer control.

Return Value:

Returns the ROLE_SYSTEM_PANE code.

getVLine

public int getVLine();

Retrieves the number of pixels associated with a vertical scroll position.

Return Value:

Returns the number of pixels in the vertical scroll bar's scroll line.

See Also: getHLine, getLine, setVLine

getXPosition

public int getXPosition();

Retrieves the horizontal position of the scroll viewer's content component.

Return Value:

Returns the horizontal position (in pixels).

Remarks:

This method implements getXPosition in the IUIPosition interface.

See Also: getYPosition, getPosition, setXPosition

getYPosition

public int getYPosition();

Retrieves the vertical position of the scroll viewer's content component.

Return Value:

Returns the vertical position (in pixels).

Remarks:

This method implements getYPosition in the IUIPosition interface.

See Also: getXPosition, getPosition, setYPosition

handleEvent

public boolean handleEvent(Event e);

Responds to scroll events sent from the horizontal and vertical scroll bars by adjusting the content, header, and scroll bar components.

Return Value:

Returns true if the event was handled; otherwise, returns false.

Parameter	Description
e	The event.

isKeyable

public boolean isKeyable();

Determines whether the control can receive keyboard input.

Return Value:

Returns true if the control can receive keyboard input; otherwise, returns false.

keyDown

public boolean keyDown(Event e, int key);

Scrolls the content component according to the key being pressed.

Return Value:

Returns true if the event was handled; otherwise, returns false.

Parameter	Description
e	The event posted to the scroll viewer control.
key	The key that has been pressed.

Remarks:

This method is called when the control has focus and a key is pressed. keyDown responds to the following key values.

Key	Response
HOME, END, PAGEUP, PAGEDOWN, UP ARROW, DOWN ARROW	Adjusts the vertical scroll bar and the vertical position of the content component accordingly.
LEFT ARROW, RIGHT ARROW	Adjusts the horizontal scroll bar and the horizontal position of the content component accordingly.

layout

public void layout();

Lays out the scroll viewer control and its components according to constraints specified in the layout manager.

Return Value:

No return value.

Remarks:

When laying out the scroll bar components, this method adjusts the position of each scroll bar to reflect the content component's current scroll position.

remove

public void remove(IUIComponent comp);

Removes the specified component from the scroll viewer control.

Return Value:

No return value.

Parameter	Description
comp	The component to be removed.

Remarks:

You can use the getLayoutComponent method to specify the component to be removed, as shown in the following example.

// Remove the horizontal scroll bar from
// the UIScrollViewer object sv.
sv.setScrollStyle(sv.getLayoutComponent(UIScrollViewer.SCROLL_HORZ),NOSHOW);

To add a component to the scroll viewer control, call the add method.

replace

public IUIComponent replace(IUIComponent comp, Object constraints);

Replaces the current component with the new component according to the specified constraints.

Return Value:

Returns the newly replaced component, or null.

Parameter	Description
comp	The new component. The constraints identifying where to replace the component. This value depends on the layout manager of the underlying UI object. This must be one of the following constraints, or the method performs no operation and returns null. SCROLL_VERT SCROLL_HORZ SCROLL_CORNER HEADER_VERT HEADER_HORZ HEADER_CORNER CONTENT

requestFocus

public void requestFocus();

Transfers focus to the viewer control's content component.

Return Value:

No return value.

setContent

public void setContent(IUIComponent content);

Sets the scroll viewer control's content to the specified component.

Return Value:

No return value.

Parameter	Description
content	The component to be displayed within the scroll viewer control.

Remarks:

To set the other components in the scroll viewer (such as scroll bars and header bars), call the add method. Be aware that calling setContent is different from calling add with the CONTENT constraint. setContent automatically converts the specified component to a UIViewer object, while add only converts the component if it does not implement the IUIPosition interface.

For more information about scroll viewers and their content, see the UIScrollViewer overview.

See Also: getContent

setHLine

public void setHLine(int line);

Sets the number of pixels associated with a horizontal scroll position.

Return Value:

No return value.

Parameter	Description
line	The number of pixels for the horizontal scroll bar's scroll line.

See Also: setVLine, setLine, getHLine

setLine

public void setLine(int hLine, int vLine);

Sets the number of pixels associated with horizontal and vertical scroll positions.

Return Value:

No return value.

Parameter	Description
hLine	The number of pixels for the horizontal scroll bar's scroll line.
vLine	The number of pixels for the vertical scroll bar's scroll line.

See Also: setHLine, setVLine, getLine

setPosition

public void setPosition(Point pt);

Moves the scroll viewer's content to the scroll position given by the specified point.

Return Value:

No return value. the new position.

Parameter	Description
pt	The requested position for the content component. The x and y coordinates of pt specify the horizontal and vertical positions (in pixels), respectively.

Remarks:

This method implements setPosition in the IUIPosition interface.

See Also: setXPosition, setYPosition, getPosition

setPosition

public void setPosition(int x, int y);

Moves the scroll viewer's content to the position given by the specified values.

Return Value:

No return value. the new position.

Parameter	Description
x	The requested horizontal position for the content component (in pixels).
y	The requested vertical position for the content component (in pixels).

Remarks:

This method implements setPosition in the IUIPosition interface.

See Also: setXPosition, setYPosition, getPosition

setScrollStyle

public void setScrollStyle(int scroller, int style);

Sets the style of the specified scroll bar.

Return Value:

No return value.

Parameter	Description
scroller	The scroll bar whose style is being set. Pass S_VERT for the vertical scroll bar, or S_HORZ for the horizontal scroll bar.
style	The style of the scroll bar. You can pass one of the following values: UIScroll.NOHIDE UIScroll.NOSHOW UIScroll.NONPROPORTIONAL

Remarks:

To apply the style to both scroll bars, you can pass only the style to setScrollStyle, as shown in the following example.

// Give both scroll bars the NOHIDE style.
myScrollViewer.setScrollStyle(UIScroll.NOHIDE);

setScrollStyle

public void setScrollStyle(int style);

Sets the style of the scroll bars.

Return Value:

No return value.

Parameter	Description
style	The style of the scroll bars. You can pass one of the following values: UIScroll.NOHIDE UIScroll.NOSHOW UIScroll.NONPROPORTIONAL

Remarks:

This method applies the specified style to both scroll bars. To individually set the style of each scroll bar, pass the scroll bar type to setScrollStyle, as shown in the following example.

// Set the horizontal scroll bar to NOHIDE
// and the vertical scroll bar to NOSHOW.
myScrollViewer.setScrollStyle(UIScrollViewer.S_HORZ, UIScroll.NOHIDE);
myScrollViewer.setScrollStyle(UIScrollViewer.S_VERT, UIScroll.NOSHOW);

setVLine

public void setVLine(int line);

Sets the number of pixels associated with a vertical scroll position.

Return Value:

No return value.

Parameter	Description
line	The number of pixels for the vertical scroll bar's scroll line.

See Also: setHLine, setLine, getVLine

setXPosition

public void setXPosition(int x);

Moves the scroll viewer's content in the horizontal direction by the specified amount.

Return Value:

No return value.

Parameter	Description
x	The requested horizontal position for the content component (in pixels).

Remarks:

This method implements setXPosition in the IUIPosition interface.

See Also: setYPosition, setPosition, getXPosition

setYPosition

public void setYPosition(int y);

Moves the scroll viewer's content in the vertical direction by the specified amount.

Return Value:

No return value.

Parameter	Description
y	The requested vertical position for the content component (in pixels).

Remarks:

This method implements setYPosition in the IUIPosition interface.

See Also: setXPosition, setPosition, getYPosition

Fields

CONT

The constant used to construct the CONTENT constraint.

CONTENT

The constraint of the content component.

H_CORNER

The constant used to construct the HEADER_CORNER index.

H_HORZ

The constant used to construct the HEADER_HORZ index.

H_VERT

The constant used to construct the HEADER_VERT index.

HEADER_BOTTOM

Positions the horizontal header bar on the bottom of the scroll viewer panel. The default position is on the top.

HEADER_CORNER

The constraint of the corner component between the header bar components.

HEADER_HORZ

The constraint of the horizontal header bar component.

HEADER_RIGHT

Positions the vertical header bar on the right side of the scroll viewer panel. The default position is on the left.

HEADER_VERT

The constraint of the vertical header bar component.

S_CORNER

The constant used to construct the SCROLL_CORNER index.

S_HORZ

The constant used to construct the SCROLL_HORZ index.

S_VERT

The constant used to construct the SCROLL_VERT index.

SCROLL_CORNER

The constraint of the corner component between the scroll bar components.

SCROLL_HORZ

The constraint of the horizontal scroll bar component.

SCROLL_LEFT

Positions the vertical scroll bar on the left side of the scroll viewer panel. The default position is on the right.

SCROLL_TOP

Positions the horizontal scroll bar on the top of the scroll viewer panel. The default position is on the bottom.

SCROLL_VERT

The constraint of the vertical scroll bar component.