HATS 7.5.1 Web API Reference

Publicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product.

com.ibm.hats.transform.html
Class EnptuiScrollbarElement

java.lang.Object
  extended by com.ibm.hats.transform.html.HTMLElement
      extended by com.ibm.hats.transform.html.EnptuiScrollbarElement

public class EnptuiScrollbarElement
extends HTMLElement

ENPTUIScrollbarElement is used to render the parts of a scrollbar indicated by an ENPTUIScrollbarComponent.


Field Summary
 
Fields inherited from class com.ibm.hats.transform.html.HTMLElement
ATTR_ACCESS_KEY, ATTR_ACTION, ATTR_ALT, ATTR_CLASS_NAME, ATTR_DIR, ATTR_FOR, ATTR_HREF, ATTR_ID, ATTR_IMG_ALT, ATTR_MAX_LENGTH, ATTR_NAME, ATTR_ON_BLUR, ATTR_ON_CHANGE, ATTR_ON_CLICK, ATTR_ON_CUT, ATTR_ON_DROP, ATTR_ON_FOCUS, ATTR_ON_KEY_DOWN, ATTR_ON_KEY_PRESS, ATTR_ON_KEY_UP, ATTR_ON_MOUSEDOWN, ATTR_ON_MOUSEOVER, ATTR_ON_PASTE, ATTR_SIZE, ATTR_SRC, ATTR_STYLE, ATTR_TARGET, ATTR_TYPE, ATTR_VALUE, CLASSNAME, FLAG_CHECKED, FLAG_DISABLED, FLAG_MULTIPLE, FLAG_READ_ONLY, FLAG_SELECTED, tagName
 
Constructor Summary
EnptuiScrollbarElement()
          Class constructor which sets the tag name to DIV and initializes the list of options.
 
Method Summary
 HTMLElement getDownButton()
          Gets the td html element to be used in rendering the down/right scrollbar button.
 String getEncodedPath()
          Returns the encoded path that the element can find its images on.
 String getFormID()
          Returns the form ID to use to submit slider drag command.
 int getLineDownPos()
          Returns the scrollbar Down button position.
 int getLineUpPos()
          Returns the scrollbar up button position.
 HTMLElement getPageDownArea()
          Gets the td html element to be used in rendering the page down area.
 int getPageDownPos()
          Returns the scrollbar page down position.
 HTMLElement getPageUpArea()
          Gets the td html element to be used in rendering the page up area.
 int getPageUpPos()
          Returns the scrollbar page up position.
 int getScreenPos()
          Returns screen location of scrollbar.
 HTMLElement getScrollbarTD()
          Gets the tr html element to be used in rendering the scrollbar.
 HTMLElement getScrollbarTR()
          Gets the tr html element to be used in rendering the scrollbar.
 int getScrollPos()
          Returns the scrollbar slider position.
 int getSize()
          Returns the number of rows or columns scrollbar uses when drawn.
 HTMLElement getSliderButton()
          Gets the td html element to be used in rendering the slider scrollbar buttons
 int getTotal()
          Returns number of scrollable values
 HTMLElement getUpButton()
          Gets the td html element to be used in rendering the up/left scrollbar button.
 boolean isButtonArrowsWhite()
          Returns Are the button arrows to be drawn white
 boolean isScripting()
          Returns Are we doing scripting on this element?
 boolean isVertical()
          Returns true if the scrollbar is drawn vertically, false otherwise.
 void render(StringBuffer buffer)
          Renders the entire set of elements making up a scrollbar.
 void setButtonArrowsWhite(boolean _b)
          Sets if the button arrows are to be drawn white
 void setClassName(String value)
          Sets the className.
 void setDownButton(HTMLElement element)
          Sets the td element to be used in rendering the down/right scrollbar button
 void setEncodedPath(String _p)
          Sets the encoded path that the element can find its images on.
 void setFormID(String _f)
          Sets the form ID to use to submit slider drag command.
 void setLineDownPos(int _p)
          Sets the scrollbar Down button position.
 void setLineUpPos(int _p)
          Sets the scrollbar up button position.
 void setPageDownArea(HTMLElement element)
          Sets the td element to be used in rendering the page down area.
 void setPageDownPos(int _p)
          Sets the scrollbar page down position.
 void setPageUpArea(HTMLElement element)
          Sets the td element to be used in rendering the page up area.
 void setPageUpPos(int _p)
          Sets the scrollbar page up position.
 void setScreenPos(int _s)
          Sets the screen location of scrollbar
 void setScripting(boolean _b)
          Sets if we are doing scripting on this element
 void setScrollbarTD(HTMLElement element)
          Sets the tr element to be used in rendering the scrollbar.
 void setScrollbarTR(HTMLElement element)
          Sets the tr element to be used in rendering the scrollbar
 void setScrollPos(int _p)
          Sets the scrollbar slider position.
 void setSize(int _s)
          Sets the number of rows or columns scrollbar uses when drawn.
 void setSliderButton(HTMLElement element)
          Sets the td element to be used in rendering the slider scrollbar buttons.
 void setTotal(int _t)
          Sets the number of scrollable values.
 void setUpButton(HTMLElement element)
          Sets the td element to be used in rendering the up/left scrollbar button.
 void setVertical(boolean _v)
          Sets if the scrollbar is drawn vertically.
 String toString()
           
 
Methods inherited from class com.ibm.hats.transform.html.HTMLElement
addFlag, appendClassName, appendStyle, buildTag, buildTag, getAttribute, getClassName, getDir, getId, getName, getStyle, getTagName, hasFlag, removeFlag, render, render, render, renderEndTag, renderEndTag, setAlign, setAttribute, setDir, setId, setName, setStyle, setTagName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

EnptuiScrollbarElement

public EnptuiScrollbarElement()
Class constructor which sets the tag name to DIV and initializes the list of options.

Method Detail

getScrollbarTR

public HTMLElement getScrollbarTR()
Gets the tr html element to be used in rendering the scrollbar.

Returns:
The tr html element to be used in rendering the scrollbar.

setScrollbarTR

public void setScrollbarTR(HTMLElement element)
Sets the tr element to be used in rendering the scrollbar

Parameters:
element - The element to be used in rendering the scrollbar.

getScrollbarTD

public HTMLElement getScrollbarTD()
Gets the tr html element to be used in rendering the scrollbar.

Returns:
The tr html element to be used in rendering the scrollbar.

setScrollbarTD

public void setScrollbarTD(HTMLElement element)
Sets the tr element to be used in rendering the scrollbar.

Parameters:
element - The element to be used in rendering the scrollbar.

getUpButton

public HTMLElement getUpButton()
Gets the td html element to be used in rendering the up/left scrollbar button.

Returns:
The html element to be used in rendering the up/left scrollbar button.

setUpButton

public void setUpButton(HTMLElement element)
Sets the td element to be used in rendering the up/left scrollbar button.

Parameters:
element - The element to be used in rendering the up/left scrollbar button.

getPageUpArea

public HTMLElement getPageUpArea()
Gets the td html element to be used in rendering the page up area.

Returns:
The td html element to be used in rendering the page up area.

setPageUpArea

public void setPageUpArea(HTMLElement element)
Sets the td element to be used in rendering the page up area.

Parameters:
element - The element to be used in rendering the page up area.

getPageDownArea

public HTMLElement getPageDownArea()
Gets the td html element to be used in rendering the page down area.

Returns:
The td html element to be used in rendering the page down area.

setPageDownArea

public void setPageDownArea(HTMLElement element)
Sets the td element to be used in rendering the page down area.

Parameters:
element - The element to be used in rendering the page down area.

getDownButton

public HTMLElement getDownButton()
Gets the td html element to be used in rendering the down/right scrollbar button.

Returns:
Returns the element to be used in rendering the down/right scrollbar button.

setDownButton

public void setDownButton(HTMLElement element)
Sets the td element to be used in rendering the down/right scrollbar button

Parameters:
element - The element to be used in rendering the down/right scrollbar button.

getSliderButton

public HTMLElement getSliderButton()
Gets the td html element to be used in rendering the slider scrollbar buttons

Returns:
Returns the element to be used in rendering the slider scrollbar buttons.

setSliderButton

public void setSliderButton(HTMLElement element)
Sets the td element to be used in rendering the slider scrollbar buttons.

Parameters:
element - The element to be used in rendering the slider scrollbar buttons.

isVertical

public boolean isVertical()
Returns true if the scrollbar is drawn vertically, false otherwise.

Returns:
Returns true if the scrollbar is drawn vertically, false otherwise.

setVertical

public void setVertical(boolean _v)
Sets if the scrollbar is drawn vertically.

Parameters:
_v - Set to true if the scrollbar is drawn vertically, false otherwise.

getEncodedPath

public String getEncodedPath()
Returns the encoded path that the element can find its images on.

Returns:
The encoded path that the element can find its images on.

setEncodedPath

public void setEncodedPath(String _p)
Sets the encoded path that the element can find its images on.

Parameters:
_p - The encoded path that the element uses to find its images.

isButtonArrowsWhite

public boolean isButtonArrowsWhite()
Returns Are the button arrows to be drawn white

Returns:
Returns true if the button arrows are being drawn white, false otherwise.

setButtonArrowsWhite

public void setButtonArrowsWhite(boolean _b)
Sets if the button arrows are to be drawn white

Parameters:
_b - Set to true if the button arrows are to be drawn white, false otherwise.

getSize

public int getSize()
Returns the number of rows or columns scrollbar uses when drawn.

Returns:
The number of rows or columns scrollbar uses when drawn.

setSize

public void setSize(int _s)
Sets the number of rows or columns scrollbar uses when drawn.

Parameters:
_s - The number of rows or columns scrollbar uses when drawn.

getTotal

public int getTotal()
Returns number of scrollable values

Returns:
int

setTotal

public void setTotal(int _t)
Sets the number of scrollable values.

Parameters:
_t - The number of scrollable value.

getScrollPos

public int getScrollPos()
Returns the scrollbar slider position.

Returns:
The scrollbar slider position.

setScrollPos

public void setScrollPos(int _p)
Sets the scrollbar slider position.

Parameters:
_p - The scrollbar slider position.

getLineUpPos

public int getLineUpPos()
Returns the scrollbar up button position.

Returns:
The scrollbar up button position.

setLineUpPos

public void setLineUpPos(int _p)
Sets the scrollbar up button position.

Parameters:
_p - The scrollbar up button position.

getLineDownPos

public int getLineDownPos()
Returns the scrollbar Down button position.

Returns:
The scrollbar Down button position.

setLineDownPos

public void setLineDownPos(int _p)
Sets the scrollbar Down button position.

Parameters:
_p - The scrollbar Down button position.

getPageUpPos

public int getPageUpPos()
Returns the scrollbar page up position.

Returns:
The scrollbar page up position.

setPageUpPos

public void setPageUpPos(int _p)
Sets the scrollbar page up position.

Parameters:
_p - The scrollbar page up position.

getPageDownPos

public int getPageDownPos()
Returns the scrollbar page down position.

Returns:
The scrollbar page down position.

setPageDownPos

public void setPageDownPos(int _p)
Sets the scrollbar page down position.

Parameters:
_p - The scrollbar page down position.

getScreenPos

public int getScreenPos()
Returns screen location of scrollbar.

Returns:
The screen location of the scrollbar.

setScreenPos

public void setScreenPos(int _s)
Sets the screen location of scrollbar

Parameters:
_s - The screen location of the scrollbar.

getFormID

public String getFormID()
Returns the form ID to use to submit slider drag command.

Returns:
The form ID to use to submit slider drag command.

setFormID

public void setFormID(String _f)
Sets the form ID to use to submit slider drag command.

Parameters:
_f - The form ID to use to submit slider drag command.

isScripting

public boolean isScripting()
Returns Are we doing scripting on this element?

Returns:
Returns true if scripting on this element, false otherwise.

setScripting

public void setScripting(boolean _b)
Sets if we are doing scripting on this element

Parameters:
_b - Set to true if scripting, false otherwise.

toString

public String toString()
Overrides:
toString in class Object

setClassName

public void setClassName(String value)
Description copied from class: HTMLElement
Sets the className. Replaces the existing class name, if any.

Overrides:
setClassName in class HTMLElement
Parameters:
value - The className to set

render

public void render(StringBuffer buffer)
Renders the entire set of elements making up a scrollbar. Rendering the end tag is still necessary for the caller.

Overrides:
render in class HTMLElement
Parameters:
buffer -

HATS 7.5.1 (201005110649)