Drag[en]gine Script Module DragonScript  1.23
Dragengine.Gui.ScrollBar.ActionScroll Class Reference

Action scroll. More...

Inheritance diagram for Dragengine.Gui.ScrollBar.ActionScroll:
Dragengine.Gui.Events.DefaultActionListener Dragengine.Gui.Events.ActionListener Dragengine.Gui.ScrollBar.ActionScroll.ActionScrollDownRight Dragengine.Gui.ScrollBar.ActionScroll.ActionScrollUpLeft

Classes

class  ActionScrollDownRight
 Action scroll down/right action. More...
 
class  ActionScrollPageDownRight
 
class  ActionScrollPageUpLeft
 
class  ActionScrollUpLeft
 Action scroll up/left action. More...
 
class  DragKnobMouseListener
 

Public Member Functions

void createContent ()
 
void dispose ()
 
void enableDirectionButtons ()
 
RectArea getHelperPositions ()
 
bool getHideIfEmpty ()
 Hide scroll bar if range is empty. More...
 
int getKnobSize ()
 
RangeModel getModel ()
 
bool getReverseWheel ()
 Reverse wheel direction. More...
 
ActionScroll new (Orientation orientation)
 
ActionScroll new (Orientation orientation, RangeModel model)
 Create scroll bar widget with model. More...
 
ActionScroll new (ScrollBar scrollBar)
 
ActionScroll new (ScrollBar scrollBar, bool isWheelAction)
 
void onAction (ActionEvent event)
 Run action. More...
 
void onButtonPress (MouseEvent event)
 
void onButtonRelease (MouseEvent event)
 
void onDesignerChanged ()
 Designer changed. More...
 
void onGuiThemeChanged ()
 
void onResize (WidgetEvent event)
 Size changed. More...
 
void rangeChanged (RangeModel rangeModel)
 
void removeAllWidgets ()
 Remove all widgets. More...
 
void setHideIfEmpty (bool hideIfEmpty)
 Set if scroll bar is hidden if range is empty. More...
 
void setModel (RangeModel rangeModel)
 
void setOrientation (Orientation orientation)
 
void setReverseWheel (bool reverseWheel)
 Set reverse wheel direction. More...
 
void updateKnobWidget ()
 
void valueChanged (RangeModel rangeModel)
 
- Public Member Functions inherited from Dragengine.Gui.Events.DefaultActionListener
DefaultActionListener new ()
 Create default action listener. More...
 

Protected Member Functions

WidgetDesigner getDesignerFromTheme ()
 Get designer from gui theme. More...
 
bool increaseValue ()
 

Protected Attributes

bool pIsWheelAction
 
ScrollBar pScrollBar
 

Detailed Description

Action scroll.

Version
1.9

Member Function Documentation

◆ createContent()

void Dragengine.Gui.ScrollBar.ActionScroll.createContent ( )

Create content widgets.

◆ dispose()

void Dragengine.Gui.ScrollBar.ActionScroll.dispose ( )

Dispose of widget.

◆ enableDirectionButtons()

void Dragengine.Gui.ScrollBar.ActionScroll.enableDirectionButtons ( )

Enable direction buttons depending on the model value.

◆ getDesignerFromTheme()

WidgetDesigner Dragengine.Gui.ScrollBar.ActionScroll.getDesignerFromTheme ( )
protected

Get designer from gui theme.

Modified to ensure a DefaultScrollBarDesigner is used if super.getDesignerFromTheme() returns null.

◆ getHelperPositions()

RectArea Dragengine.Gui.ScrollBar.ActionScroll.getHelperPositions ( )

Helper positions. If not present yet they are calculated.

◆ getHideIfEmpty()

bool Dragengine.Gui.ScrollBar.ActionScroll.getHideIfEmpty ( )

Hide scroll bar if range is empty.

◆ getKnobSize()

int Dragengine.Gui.ScrollBar.ActionScroll.getKnobSize ( )

Size of the drag knob.

◆ getModel()

RangeModel Dragengine.Gui.ScrollBar.ActionScroll.getModel ( )

Range model.

◆ getReverseWheel()

bool Dragengine.Gui.ScrollBar.ActionScroll.getReverseWheel ( )

Reverse wheel direction.

Version
1.9

If false wheeling up decreases the range model. If true increases the range model.

◆ increaseValue()

bool Dragengine.Gui.ScrollBar.ActionScroll.increaseValue ( )
protected

◆ new() [1/4]

ActionScroll Dragengine.Gui.ScrollBar.ActionScroll.new ( Orientation  orientation)

Create scroll bar widget.

◆ new() [2/4]

ActionScroll Dragengine.Gui.ScrollBar.ActionScroll.new ( Orientation  orientation,
RangeModel  model 
)

Create scroll bar widget with model.

◆ new() [3/4]

◆ new() [4/4]

ActionScroll Dragengine.Gui.ScrollBar.ActionScroll.new ( ScrollBar  scrollBar,
bool  isWheelAction 
)

◆ onAction()

void Dragengine.Gui.ScrollBar.ActionScroll.onAction ( ActionEvent  event)

Run action.

Reimplemented from Dragengine.Gui.Events.DefaultActionListener.

◆ onButtonPress()

void Dragengine.Gui.ScrollBar.ActionScroll.onButtonPress ( MouseEvent  event)

Mouse button has been pressed.

◆ onButtonRelease()

void Dragengine.Gui.ScrollBar.ActionScroll.onButtonRelease ( MouseEvent  event)

Mouse button has been released.

◆ onDesignerChanged()

void Dragengine.Gui.ScrollBar.ActionScroll.onDesignerChanged ( )

Designer changed.

◆ onGuiThemeChanged()

void Dragengine.Gui.ScrollBar.ActionScroll.onGuiThemeChanged ( )

Notification that the gui theme changed.

◆ onResize()

void Dragengine.Gui.ScrollBar.ActionScroll.onResize ( WidgetEvent  event)

Size changed.

◆ rangeChanged()

void Dragengine.Gui.ScrollBar.ActionScroll.rangeChanged ( RangeModel  rangeModel)

Send if the outer range properties like minimum value, maximum value or page size has changed.

◆ removeAllWidgets()

void Dragengine.Gui.ScrollBar.ActionScroll.removeAllWidgets ( )

Remove all widgets.

◆ setHideIfEmpty()

void Dragengine.Gui.ScrollBar.ActionScroll.setHideIfEmpty ( bool  hideIfEmpty)

Set if scroll bar is hidden if range is empty.

◆ setModel()

void Dragengine.Gui.ScrollBar.ActionScroll.setModel ( RangeModel  rangeModel)

Set range model.

◆ setOrientation()

void Dragengine.Gui.ScrollBar.ActionScroll.setOrientation ( Orientation  orientation)

Set oriantation of the scrollbar.

◆ setReverseWheel()

void Dragengine.Gui.ScrollBar.ActionScroll.setReverseWheel ( bool  reverseWheel)

Set reverse wheel direction.

Version
1.9

If false wheeling up decreases the range model. If true increases the range model.

◆ updateKnobWidget()

void Dragengine.Gui.ScrollBar.ActionScroll.updateKnobWidget ( )

Update knob widget geometry.

◆ valueChanged()

void Dragengine.Gui.ScrollBar.ActionScroll.valueChanged ( RangeModel  rangeModel)

Send if the value has changed.

Member Data Documentation

◆ pIsWheelAction

bool Dragengine.Gui.ScrollBar.ActionScroll.pIsWheelAction
protected

◆ pScrollBar

ScrollBar Dragengine.Gui.ScrollBar.ActionScroll.pScrollBar
protected

The documentation for this class was generated from the following file: