Drag[en]gine Script Module DragonScript Script API  1.0
PanelPlayerChoiceEntry Class Reference

Simple text to be used as option in a player choice box. More...

Inheritance diagram for PanelPlayerChoiceEntry:
Label Widget TextModelNotifier

Public Member Functions

void dispose ()
 Dispose of widget. More...
ActionListener getAction ()
 Select action. More...
bool getActive ()
 Widget is active. More...
Color getBgColorActive ()
 Active background color. More...
Color getBgColorInactive ()
 Inactive background color. More...
Color getTextColorActive ()
 Active text color. More...
Color getTextColorInactive ()
 Inactive text color. More...
PanelPlayerChoiceEntry new (String text, ActionListener action)
 Create player choice option. More...
void onButtonPress (MouseEvent event)
 Mouse button pressed. More...
void onMouseEnter (MouseEvent event)
 Mouse entered the widget. More...
void onMouseLeave (MouseEvent event)
 Mouse left widget. More...
void setActive (bool active)
 Set if widget is active. More...
void setBgColorActive (Color color)
 Set active background color. More...
void setBgColorInactive (Color color)
 Set inactive background color. More...
void setTextColorActive (Color color)
 Set active text color. More...
void setTextColorInactive (Color color)
 Set inactive text color. More...
void updateColors ()
 Update background and text colors. More...
- Public Member Functions inherited from Label
void dispose ()
 Dispose of widget. More...
int getAlignment ()
 Text alignment. More...
int getMaximalWidth ()
 Maximal width of text before break occurs. More...
Point getMinimumSize ()
 Minimal size of widget. More...
Point getMinimumSizeForWidth (int width)
 Minimum size of widget using reference widget width and variable height. More...
TextModel getModel ()
 Text model. More...
String getText ()
 Text. More...
Point getTextSize ()
 Size of text. More...
bool getWordWrap ()
 Word wrap if line is too long. More...
Label new (String text)
 Create label. More...
Label new (String text, int alignment)
 Create labe with alignmentl. More...
Label new (TextModel model)
 Create label. More...
Label new (TextModel model, int alignment)
 Create label with alignment. More...
void onGuiThemeChanged ()
 Gui theme changed. More...
void onResize (WidgetEvent event)
 Size changed. More...
void onSetFont ()
 Font changed. More...
void onSetForegroundColor ()
 Foreground color changed. More...
void onStateChanged (StateChangeEvent event)
 State changed. More...
void setAlignment (int alignment)
 Set text alignment. More...
void setMaximalWidth (int width)
 Set maximal width of text before break occurs. More...
void setModel (TextModel model)
 Set text model. More...
void setText (String text)
 Set text. More...
void setWordWrap (bool wordWrap)
 Set word wrap if line is too long. More...
void textChanged (TextModel textModel)
 Text changed. More...
- Public Member Functions inherited from Widget
void addDragListener (DragListener listener)
void addFocusListener (FocusListener listener)
 Add focus listener. More...
void addKeyListener (KeyListener listener)
void addMouseListener (MouseListener listener)
void addStateChangeListener (StateChangeListener listener)
 Add state change listener. More...
void addWidgetListener (WidgetListener listener)
 Add widget listener. More...
bool canGrabFullFocus ()
void captureMouse ()
void dispose ()
Widget findFocusableWidget ()
Widget findLastFocusableWidget ()
CanvasCreator getBackgroundCanvasCreator ()
 Background canvas creator or null to use background color. More...
Color getBackgroundColor ()
Border getBorder ()
BorderSize getBorderSize ()
RectArea getBoundary ()
 Rectangulare boundary of the widget. More...
RectArea getBoundaryWithBorder ()
 Rectangulare boundary of the widget including border. More...
bool getCanFocus ()
CanvasView getCanvasBackground ()
CanvasView getCanvasContent ()
CanvasView getCanvasWidget ()
ColorMatrix getColorTransformation ()
 Color transformation. More...
Desktop getDesktop ()
Point getDesktopPosition ()
 Widget position in desktop coordinates. More...
bool getEnabled ()
MousePointer getFirstMousePointer ()
Font getFont ()
Color getForegroundColor ()
GuiTheme getGuiTheme ()
bool getHasFocus ()
int getHeight ()
 Height of widget. More...
RangeModel getHorizontalRangeModel ()
 Horizontal range model for viewports to synchronize the horizontal scrollbar. More...
Point getMinimumSize ()
Point getMinimumSizeForHeight (int height)
 Minimum size of widget using reference widget height and variable width. More...
Point getMinimumSizeForHeightWithBorder (int height)
 Minimum size of widget with border using reference widget height and variable width. More...
Point getMinimumSizeForWidth (int width)
 Minimum size of widget using reference widget width and variable height. More...
Point getMinimumSizeForWidthWithBorder (int width)
 Minimum size of widget with border using reference widget width and variable height. More...
Point getMinimumSizeWithBorder ()
MousePointer getMousePointer ()
Container getParent ()
Point getPosition ()
 Position of the widget. More...
Point getRelativePosition (Container parent)
 Widget position in parent widget coordinates. More...
Point getScreenPosition ()
 Widget position in screen coordinates. More...
RectArea getScreenRectArea ()
Point getSetMinimumSize ()
Point getSize ()
 Size of the widget. More...
float getTotalTransparency ()
TexMatrix2 getTransformation ()
float getTransparency ()
RangeModel getVerticalRangeModel ()
 Vertical range model for viewports to synchronize the vertical scrollbar. More...
bool getVisible ()
Widget getWidgetAt (Point position)
 Widget at coordinates or null if not found. More...
int getWidth ()
 Width of widget. More...
Window getWindow ()
Point getWindowPosition ()
 Widget position in window coordinates. More...
int getX ()
 X position of widget. More...
int getY ()
 Y position of widget. More...
void grabFocus ()
bool hasParent (Container container)
bool isBackgroundColorSet ()
bool isFontSet ()
bool isForegroundColorSet ()
bool isGuiThemeSet ()
bool isMinimumSizeSet ()
bool isMouseInside ()
 Mouse is hovering over this widget. More...
bool isPointInside (Point position)
bool isTransformationSet ()
void layoutParent ()
Widget new ()
Widget new (int x, int y, int width, int height)
Widget nextFocusWidget ()
 Find next widget in the focus cycle that can grab the focus. More...
void notifyBorderParametersChanged ()
void onButtonPress (MouseEvent event)
void onButtonRelease (MouseEvent event)
void onDispose (WidgetEvent event)
 Window is disposing. More...
void onDragDrop (DragEvent event)
void onDragEnter (DragEvent event)
void onDragLeave (DragEvent event)
void onDragOver (DragEvent event)
void onFocusLost (FocusEvent event)
 Widget lost focus. More...
void onFocusReceived (FocusEvent event)
 Widget received focus. More...
void onGuiThemeChanged ()
void onHidden (WidgetEvent event)
 Widget has been hidden. More...
void onKeyPress (KeyEvent event)
void onKeyRelease (KeyEvent event)
void onKeyType (KeyEvent event)
void onMouseEnter (MouseEvent event)
void onMouseLeave (MouseEvent event)
void onMouseMove (MouseEvent event)
void onReposition (WidgetEvent event)
 Position changed. More...
void onResize (WidgetEvent event)
 Size changed. More...
void onSetBackgroundColor ()
void onSetFont ()
void onSetForegroundColor ()
void onShown (WidgetEvent event)
 Widget has been shown. More...
void onStateChanged (StateChangeEvent event)
 State changed. More...
Widget prevFocusWidget ()
 Find previous widget in the focus cycle that can grab the focus. More...
void processEvent (Event event)
void releaseMouse ()
void removeDragListener (DragListener listener)
void removeFocusListener (FocusListener listener)
 Remove focus listener. More...
void removeKeyListener (KeyListener listener)
void removeMouseListener (MouseListener listener)
void removeStateChangeListener (StateChangeListener listener)
 Remove state change listener. More...
void removeWidgetListener (WidgetListener listener)
 Remove widget listener. More...
void requestGrabFocus (Widget widget)
void sendEvent (Event event)
void sendEventToListeners (Event event, bool sendToParent)
 Send event to all appropriate listeners for events of its kind. More...
void setBackgroundCanvasCreator (CanvasCreator creator)
 Set background canvas creator or null to use background color. More...
void setBackgroundColor (Color color)
void setBorder (Border border)
void setCanFocus (bool canFocus)
void setColorTransformation (ColorMatrix transformation)
 Set color transformation. More...
void setEnabled (bool enabled)
void setFont (Font font)
void setForegroundColor (Color color)
void setGuiTheme (GuiTheme theme)
void setHasFocus (bool hasFocus)
void setHeight (int height)
 Set height of widget. More...
void setMinimumSize (Point size)
void setMousePointer (MousePointer mousePointer)
void setParent (Container parent)
void setPosition (Point position)
 Set position of widget. More...
void setSize (Point size)
 Set size of widget. More...
void setTransformation (TexMatrix2 transformation)
void setTransparency (float transparency)
void setVisible (bool visible)
void setWidth (int width)
 Set width of widget. More...
void setX (int x)
 Set X position of widget. More...
void setY (int y)
 Set Y Position of widget. More...
void stopRepeatEventTimer ()
void updateCanvasBackground ()
 Update background canvas content. More...

Additional Inherited Members

- Public Attributes inherited from Label
final int BOTTOM = 0h4
 Align text at bottom side. More...
final int CENTER = 0h2
 Align text center. More...
final int LEFT = 0h0
 Align text left side. More...
final int MIDDLE = 0h8
 Align text middled. More...
final int RIGHT = 0h1
 Align text right side. More...
final int TOP = 0h0
 Align text at top side. More...

Detailed Description

Simple text to be used as option in a player choice box.

Changes the background and text color when the mouse enters and leaves the widget.

Member Function Documentation

◆ dispose()

void dispose ( )

Dispose of widget.

◆ getAction()

ActionListener getAction ( )

Select action.

◆ getActive()

bool getActive ( )

Widget is active.

◆ getBgColorActive()

Color getBgColorActive ( )

Active background color.

◆ getBgColorInactive()

Color getBgColorInactive ( )

Inactive background color.

◆ getTextColorActive()

Color getTextColorActive ( )

Active text color.

◆ getTextColorInactive()

Color getTextColorInactive ( )

Inactive text color.

◆ new()

PanelPlayerChoiceEntry new ( String  text,
ActionListener  action 

Create player choice option.

◆ onButtonPress()

void onButtonPress ( MouseEvent  event)

Mouse button pressed.

◆ onMouseEnter()

void onMouseEnter ( MouseEvent  event)

Mouse entered the widget.

◆ onMouseLeave()

void onMouseLeave ( MouseEvent  event)

Mouse left widget.

◆ setActive()

void setActive ( bool  active)

Set if widget is active.

◆ setBgColorActive()

void setBgColorActive ( Color  color)

Set active background color.

◆ setBgColorInactive()

void setBgColorInactive ( Color  color)

Set inactive background color.

◆ setTextColorActive()

void setTextColorActive ( Color  color)

Set active text color.

◆ setTextColorInactive()

void setTextColorInactive ( Color  color)

Set inactive text color.

◆ updateColors()

void updateColors ( )

Update background and text colors.

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