|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.kalmeo.kuix.widget.Widget
org.kalmeo.kuix.widget.ScrollPane
public class ScrollPane
This class represents a scroll pane.
For further informations, visit the Kuix widgets reference page.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.kalmeo.kuix.widget.Widget |
---|
Widget.BindInstruction |
Field Summary | |
---|---|
protected Widget |
container
|
Fields inherited from class org.kalmeo.kuix.widget.Widget |
---|
bindInstructions, DEFAULT_ALIGN, DEFAULT_BACKGROUND_ALIGN, DEFAULT_BACKGROUND_REPEAT, DEFAULT_BORDER, DEFAULT_GAP, DEFAULT_MARGIN, DEFAULT_MIN_SIZE, DEFAULT_PADDING, DEFAULT_SPAN, DEFAULT_WEIGHT, next, parent, previous |
Constructor Summary | |
---|---|
ScrollPane()
Construct a ScrollPane |
|
ScrollPane(java.lang.String tag)
Construct a ScrollPane |
|
ScrollPane(java.lang.String tag,
boolean useMarkers)
Construct a ScrollPane |
Method Summary | |
---|---|
Widget |
add(Widget widget)
Add a Widget to this as child |
boolean |
bestScrollToChild(Widget child,
boolean useIncrementLimit)
Arrange the scroll offset according to the child position |
protected Widget |
getContainer()
|
Widget |
getInternalChildInstance(java.lang.String tag)
Returns the first internal child instance corresponding to the given tag . |
Layout |
getLayout()
|
ScrollBar |
getScrollBar()
Return the ScrollBar instance. |
void |
invalidate(Widget fromWidget)
Invalidate the widget's size and position and propagate the information to its parent. |
boolean |
isAutoScroll()
|
boolean |
isChildInsideClippedArea(Widget child)
Check if the given child widget has a part of its area in
the ScrollPane clipped area. |
boolean |
isHorizontal()
|
boolean |
isMarkerWidget(Widget widget)
Check if widget is one of the ScrollPane markers. |
boolean |
isShowScrollBar()
|
boolean |
processPointerEvent(byte type,
int x,
int y)
Process a pointer event |
void |
removeAll()
Remove all childs. |
boolean |
setAttribute(java.lang.String name,
java.lang.String value)
Set the value to the specified attribute representing by
the name |
void |
setAutoScroll(boolean autoScroll)
The autoScroll attribute force the scroll position to the max value each time the ScrollPane content change or is invalidated. |
void |
setHorizontal(boolean horizontal)
|
void |
setShowScrollBar(boolean showScrollBar)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final Widget container
Constructor Detail |
---|
public ScrollPane()
ScrollPane
public ScrollPane(java.lang.String tag)
ScrollPane
tag
- public ScrollPane(java.lang.String tag, boolean useMarkers)
ScrollPane
tag
- useMarkers
- Method Detail |
---|
public boolean setAttribute(java.lang.String name, java.lang.String value)
Widget
value
to the specified attribute representing by
the name
setAttribute
in class Widget
true
if the attribute existspublic Widget getInternalChildInstance(java.lang.String tag)
Widget
tag
.
getInternalChildInstance
in class Widget
public Layout getLayout()
getLayout
in class Widget
public boolean isHorizontal()
public void setHorizontal(boolean horizontal)
horizontal
- the horizontal to setpublic boolean isShowScrollBar()
public void setShowScrollBar(boolean showScrollBar)
showScrollBar
- the showScrollBar to setpublic boolean isAutoScroll()
public void setAutoScroll(boolean autoScroll)
ScrollPane
content change or is invalidated.
autoScroll
- the autoScroll to setpublic boolean isMarkerWidget(Widget widget)
widget
is one of the ScrollPane markers.
widget
-
true
if the given widget is one of the ScrollPane
markers.protected Widget getContainer()
public ScrollBar getScrollBar()
ScrollBar
instance.
public void invalidate(Widget fromWidget)
Widget
doLayout()
and paint() method on all
invalidated widgets.
invalidate
in class Widget
fromWidget
- the Widget responsible of the invalidation.public boolean isChildInsideClippedArea(Widget child)
child
widget has a part of its area in
the ScrollPane
clipped area.
child
-
true
if the child
widget has a part of
its area in the ScrollPane
clipped area.public boolean bestScrollToChild(Widget child, boolean useIncrementLimit)
child
- useIncrementLimit
-
true
the child is displayable after scroll, else false
public Widget add(Widget widget)
Widget
Widget
to this as child
add
in class Widget
widget
- The Widget
to add
Widget
public void removeAll()
Widget
removeAll
in class Widget
public boolean processPointerEvent(byte type, int x, int y)
Widget
processPointerEvent
in class Widget
true
if the event is treated by the widget
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |