Reference for JVM version of SpaceVIL  0.3.5.8
SpaceVIL (Space of Visual Items Layout) is a cross-platform and multilingual framework for creating GUI client applications for .NET Standard, .NET Core and JVM. SpaceVIL is based on OpenGL graphic technology and GLFW. Using this framework in conjunction with .Net Core or with a JVM, you can work and create graphical client applications on Linux, Mac OS X and Windows.
com.spvessel.spacevil.ButtonToggle Class Reference

ButtonToggle is the basic implementation of a user interface button with the ability to be enabled or be disabled. More...

Inherits com.spvessel.spacevil.Prototype.

Inherited by com.spvessel.spacevil.Indicator.CustomToggle.

Public Member Functions

void release ()
 Disposing ButtonToggle resources if the item was removed. More...
 
 ButtonToggle ()
 Default ButtonToggle constructor. More...
 
 ButtonToggle (String text)
 Constructs a ButtonToggle with the specified text. More...
 
boolean isToggled ()
 Returns True if this button is toggled otherwise returns False. More...
 
void setToggled (boolean value)
 Toggles this button between on or off. More...
 
void setTextAlignment (ItemAlignment... alignment)
 Setting alignment of a ButtonToggle text. More...
 
void setTextAlignment (List< ItemAlignment > alignment)
 Setting alignment of a ButtonToggle text. More...
 
void setTextMargin (Indents margin)
 Setting indents for the text to offset text relative to ButtonToggle. More...
 
void setTextMargin (int left, int top, int right, int bottom)
 Setting indents for the text to offset text relative to ButtonToggle. More...
 
Indents getTextMargin ()
 Getting indents of the text. More...
 
void setFont (Font font)
 Setting font of the text. More...
 
void setFontSize (int size)
 Setting font size of the text. More...
 
void setFontStyle (int style)
 Setting font style of the text. More...
 
void setFontFamily (String fontFamily)
 Setting new font family of the text. More...
 
Font getFont ()
 Getting the current font of the text. More...
 
void setText (String text)
 Setting the text. More...
 
String getText ()
 Getting the current text of the ButtonToggle. More...
 
int getTextWidth ()
 Getting the text width (useful when you need resize ButtonToggle by text width). More...
 
int getTextHeight ()
 Getting the text height (useful when you need resize ButtonToggle by text height). More...
 
void setForeground (Color color)
 Setting text color of a ButtonToggle. More...
 
void setForeground (int r, int g, int b)
 Setting text color of a ButtonToggle in byte RGB format. More...
 
void setForeground (int r, int g, int b, int a)
 Setting background color of an item in byte RGBA format. More...
 
void setForeground (float r, float g, float b)
 Setting text color of a ButtonToggle in float RGB format. More...
 
void setForeground (float r, float g, float b, float a)
 Setting text color of a ButtonToggle in float RGBA format. More...
 
Color getForeground ()
 Getting current text color. More...
 
void initElements ()
 Initializing text in the ButtonToggle. More...
 
void setStyle (Style style)
 Setting style of the ButtonToggle. More...
 
- Public Member Functions inherited from com.spvessel.spacevil.Prototype
 Prototype ()
 Default constructor of Prototype class. More...
 
void setHandler (CoreWindow handler)
 Setting the window to which the item will belong. More...
 
CoreWindow getHandler ()
 Getting the window to which the item belongs. More...
 
String getToolTip ()
 Getting tooltip text of the item. More...
 
void setToolTip (String text)
 Setting tooltip text of the item. More...
 
Prototype getParent ()
 Getting the parent of the item. More...
 
void setParent (Prototype parent)
 Setting the parent of the item. More...
 
Spacing getSpacing ()
 Getting indents between children of a container type item. More...
 
void setSpacing (Spacing spacing)
 Setting indents between children of a container type item. More...
 
void setSpacing (int horizontal, int vertical)
 Setting indents between children of a container type item. More...
 
Indents getPadding ()
 Getting indents of an item for offset its children. More...
 
void setPadding (Indents padding)
 Setting indents of an item to offset its children. More...
 
void setPadding (int left, int top, int right, int bottom)
 Setting indents of an item to offset its children. More...
 
Indents getMargin ()
 Getting the indents of an item to offset itself relative to its container. More...
 
void setMargin (Indents margin)
 Setting the indents of an item to offset itself relative to its container. More...
 
void setMargin (int left, int top, int right, int bottom)
 Setting the indents of an item to offset itself relative to its container. More...
 
void setBorder (Border border)
 Setting border of an item's shape. More...
 
void setBorderFill (Color fill)
 Setting the border color of an item's shape. More...
 
Color getBorderFill ()
 Getting the border color oa an item's shape. More...
 
void setBorderFill (int r, int g, int b)
 Setting the border color of an item's shape in byte RGB format. More...
 
void setBorderFill (int r, int g, int b, int a)
 Setting the border color of an item's shape in byte RGB format. More...
 
void setBorderFill (float r, float g, float b)
 Setting the border color of an item's shape in float RGB format. More...
 
void setBorderFill (float r, float g, float b, float a)
 Setting the border color of an item's shape in float RGBA format. More...
 
void setBorderRadius (CornerRadius radius)
 Setting radius of the border's corners. More...
 
void setBorderRadius (int radius)
 Setting border radius with the same values for each corner of the rectangle object. More...
 
CornerRadius getBorderRadius ()
 Getting border radiuses. More...
 
void setBorderThickness (int thickness)
 Setting border thickness of an item's shape. More...
 
int getBorderThickness ()
 Getting border thickness of an item's shape. More...
 
List< float[]> getTriangles ()
 Getting triangles of item's shape. More...
 
void setTriangles (List< float[]> triangles)
 Setting triangles as item's shape. More...
 
void makeShape ()
 Making default item's shape. More...
 
void setBackground (Color color)
 Setting background color of an item's shape. More...
 
void setBackground (int r, int g, int b)
 Setting background color of an item's shape in byte RGB format. More...
 
void setBackground (int r, int g, int b, int a)
 Setting background color of an item in byte RGBA format. More...
 
void setBackground (float r, float g, float b)
 Setting background color of an item in float RGB format. More...
 
void setBackground (float r, float g, float b, float a)
 Setting background color of an item in float RGBA format. More...
 
Color getBackground ()
 Getting background color of an item. More...
 
void setItemName (String name)
 Setting the name of the item. More...
 
String getItemName ()
 Getting the name of the item. More...
 
void setMinWidth (int width)
 Setting the minimum width limit. More...
 
int getMinWidth ()
 Getting the minimum width limit. More...
 
void setWidth (int width)
 Setting item width. More...
 
int getWidth ()
 Getting item width. More...
 
void setMaxWidth (int width)
 Setting the maximum width limit. More...
 
int getMaxWidth ()
 Getting the maximum width limit. More...
 
void setMinHeight (int height)
 Setting the minimum height limit. More...
 
int getMinHeight ()
 Getting the minimum height limit. More...
 
void setHeight (int height)
 Setting item height. More...
 
int getHeight ()
 Getting item height. More...
 
void setMaxHeight (int height)
 Setting the maximum height limit. More...
 
int getMaxHeight ()
 Getting the maximum height limit. More...
 
void setSize (int width, int height)
 Setting item size (width and height). More...
 
Size getSize ()
 Getting current item size. More...
 
void setMinSize (int width, int height)
 Setting minimum item size limit (width and height limits). More...
 
Size getMinSize ()
 Getting current item minimum size limit. More...
 
void setMaxSize (int width, int height)
 Setting maximum item size limit (width and height limits). More...
 
Size getMaxSize ()
 Getting current item maximum size limit. More...
 
void setAlignment (List< ItemAlignment > alignment)
 Setting an alignment of an item's shape relative to its container. More...
 
void setAlignment (ItemAlignment... alignment)
 Setting an alignment of an item's shape relative to its container. More...
 
List< ItemAlignmentgetAlignment ()
 Getting an alignment of an item's shape relative to its container. More...
 
void setSizePolicy (SizePolicy width, SizePolicy height)
 Setting the size policy of an item's shape. More...
 
void setWidthPolicy (SizePolicy policy)
 Setting width policy of an item's shape. More...
 
SizePolicy getWidthPolicy ()
 Getting width policy of an item's shape.Can be FIXED (shape not changes its size) or EXPAND (shape is stretched to all available space). More...
 
void setHeightPolicy (SizePolicy policy)
 Setting height policy of an item's shape. More...
 
SizePolicy getHeightPolicy ()
 Getting height policy of an item's shape.Can be FIXED (shape not changes its size) or EXPAND (shape is stretched to all available space). More...
 
void setPosition (int x, int y)
 Setting item position. More...
 
void setX (int x)
 Setting X coordinate of the left-top corner of a shape. More...
 
int getX ()
 Getting X coordinate of the left-top corner of a shape. More...
 
void setY (int y)
 Setting Y coordinate of the left-top corner of a shape. More...
 
int getY ()
 Getting Y coordinate of the left-top corner of a shape. More...
 
void setConfines ()
 Setting the confines of the item relative to its parent's size and position. More...
 
void setConfines (int x0, int x1, int y0, int y1)
 Setting the confines of the item relative to its parent's size and position. More...
 
Style getCoreStyle ()
 Getting the core (only appearance properties without inner styles) style of an item. More...
 
boolean isShadowDrop ()
 Getting the shadow visibility status of an item. More...
 
void setShadowDrop (boolean value)
 Setting the shadow visibility status of an item. More...
 
void setShadowRadius (int radius)
 Setting the specified blur radius of the shadow. More...
 
int getShadowRadius ()
 Getting the shadow blur raduis. More...
 
Color getShadowColor ()
 Getting shadow color. More...
 
void setShadowColor (Color color)
 Setting shadow color. More...
 
Position getShadowPos ()
 Getting the offset of the shadow relative to the position of the item. More...
 
int[] getShadowExtension ()
 Getting the values of shadow extensions in pixels. More...
 
void setShadowExtension (int wExtension, int hExtension)
 Setting the values of shadow extensions in pixels. More...
 
void setShadow (int radius, int x, int y, Color color)
 Setting the shadow with specified blur radius, axis shifts, shadow color. More...
 
void addItemState (ItemStateType type, ItemState state)
 Adding visual state for an item. More...
 
void removeItemState (ItemStateType type)
 Removing visual state of an item by type. More...
 
void removeAllItemStates ()
 Removing all item visual states. More...
 
ItemState getState (ItemStateType type)
 Getting item visual state by its type. More...
 
List< InterfaceBaseItemgetItems ()
 Getting list of the Prototype's inner items (children). More...
 
boolean removeItem (InterfaceBaseItem item)
 Removing the specified item from container (this). More...
 
void clear ()
 Removing all children. More...
 
void insertItem (InterfaceBaseItem item, int index)
 Inserting item to the container (this). More...
 
void addItems (InterfaceBaseItem... items)
 Adding sequence of items into the container (this). More...
 
void addItem (InterfaceBaseItem item)
 Adding item into the container (this). More...
 
void update (GeometryEventType type, int value)
 Updating an item size or/and position. More...
 
boolean isDrawable ()
 Getting the drawable (visibility) status of an item. More...
 
void setDrawable (boolean value)
 Setting the drawable (visibility) status of an item. More...
 
boolean isVisible ()
 Setting the visibility status of an item. More...
 
void setVisible (boolean value)
 Setting the visibility status of an item. More...
 
boolean isPassEvents ()
 Getting boolean value to know if this item can pass further any input events (mouse, keyboard and etc.). More...
 
boolean isPassEvents (InputEventType e)
 Getting boolean value to know if this item can pass further the specified type of input events (mouse, keyboard and etc.). More...
 
List< InputEventTypegetPassEvents ()
 Getting all allowed input events. More...
 
List< InputEventTypeGetBlockedEvents ()
 Getting all blocked input events. More...
 
void setPassEvents (boolean value)
 Setting on or off so that this item can pass further any input events (mouse, keyboard and etc.). More...
 
void setPassEvents (boolean value, InputEventType e)
 Setting on or off so that this item can pass further the specified type of input events (mouse, keyboard and etc.). More...
 
void setPassEvents (boolean value, List< InputEventType > events)
 Setting on or off so that this item can pass further the specified types of input events (mouse, keyboard and etc.). More...
 
void setPassEvents (boolean value, InputEventType... events)
 Setting on or off so that this item can pass further the specified types of input events (mouse, keyboard and etc.). More...
 
boolean isDisabled ()
 Returns True if this item is disabled (non-interactive) otherwise returns False. More...
 
void setDisabled (boolean value)
 Setting this item disabled (become non-interactive) or enabled. More...
 
boolean isMouseHover ()
 Returns True if this item is hovered otherwise returns False. More...
 
void setMouseHover (boolean value)
 Setting this item hovered (mouse cursor located within item's shape). More...
 
boolean isMousePressed ()
 Returns True if mouse is pressed on this item (mouse cursor located within item's shape and any of the mouse button is pressed) otherwise False. More...
 
void setMousePressed (boolean value)
 Setting True if you want that mouse is pressed on this item (mouse cursor located within item's shape and any of the mouse button is pressed) otherwise False. More...
 
boolean isFocused ()
 Returns True if this item gets focus otherwise False. More...
 
void setFocus ()
 Setting focus on this item if it is focusable. More...
 
void setContent (List< InterfaceBaseItem > content)
 Setting content for this item. More...
 
Figure isCustomFigure ()
 Getting the custom shape if it is set. More...
 
void setCustomFigure (Figure figure)
 Setting the custom shape to replace the default rectangle shape. More...
 
ItemHoverRule getHoverRule ()
 Getting the hovering rule of this item. More...
 
void setHoverRule (ItemHoverRule rule)
 Setting the hovering rule for this item. More...
 
CursorImage getCursor ()
 Getting the mouse cursor image of this item. More...
 
void setCursor (EmbeddedCursor cursor)
 Setting mouse cursor image for this item from embedded cursors. More...
 
void setCursor (CursorImage cursor)
 Setting mouse cursor image for this item. More...
 
void setCursor (BufferedImage bitmap)
 Creating and setting mouse cursor image for this item from specified bitmap image. More...
 
void setCursor (BufferedImage bitmap, int width, int height)
 Creating and setting mouse cursor image for this item from specified scaled bitmap image. More...
 

Public Attributes

EventMouseMethodState eventToggle = new EventMouseMethodState()
 Event that is invoked when a button toggles. More...
 
- Public Attributes inherited from com.spvessel.spacevil.Prototype
EventCommonMethodState eventResize = new EventCommonMethodState()
 Event that is invoked when an item is resizing. More...
 
EventCommonMethodState eventDestroy = new EventCommonMethodState()
 Event that is invoked when an item is destroyed (removed). More...
 
EventMouseMethodState eventMouseHover = new EventMouseMethodState()
 Event that is invoked when mouse cursor enters inside an item area. More...
 
EventMouseMethodState eventMouseLeave = new EventMouseMethodState()
 Event that is invoked when mouse cursor leaves inside an item area. More...
 
EventMouseMethodState eventMouseClick = new EventMouseMethodState()
 Event that is invoked when mouse click (release) on an item. More...
 
EventMouseMethodState eventMouseDoubleClick = new EventMouseMethodState()
 Event that is invoked when mouse double click on an item. More...
 
EventMouseMethodState eventMousePress = new EventMouseMethodState()
 Event that is invoked when mouse press on an item. More...
 
EventMouseMethodState eventMouseDrag = new EventMouseMethodState()
 Event that is invoked when mouse drag on an item. More...
 
EventMouseMethodState eventMouseDrop = new EventMouseMethodState()
 Event that is invoked when mouse drop on an item. More...
 
EventMouseMethodState eventScrollUp = new EventMouseMethodState()
 Event that is invoked when mouse wheel scrolls up on an item. More...
 
EventMouseMethodState eventScrollDown = new EventMouseMethodState()
 Event that is invoked when mouse wheel scrolls down on an item. More...
 
EventKeyMethodState eventKeyPress = new EventKeyMethodState()
 Event that is invoked when key of keyboard is pressed. More...
 
EventKeyMethodState eventKeyRelease = new EventKeyMethodState()
 Event that is invoked when key of keyboard is released. More...
 
EventInputTextMethodState eventTextInput = new EventInputTextMethodState()
 Event that is invoked when typing text on the keyboard. More...
 
boolean isFocusable = true
 Item's focusable property. More...
 

Additional Inherited Members

- Protected Member Functions inherited from com.spvessel.spacevil.Prototype
void updateState ()
 Updating Prototype's state according to its ItemStateType. More...
 
void setFocused (boolean value)
 
boolean getHoverVerification (float xpos, float ypos)
 
int[] getConfines ()
 
void setState (ItemStateType state)
 

Detailed Description

ButtonToggle is the basic implementation of a user interface button with the ability to be enabled or be disabled.

Contains text.

Supports all events except drag and drop.

Constructor & Destructor Documentation

◆ ButtonToggle() [1/2]

com.spvessel.spacevil.ButtonToggle.ButtonToggle ( )

Default ButtonToggle constructor.

Text is empty.

◆ ButtonToggle() [2/2]

com.spvessel.spacevil.ButtonToggle.ButtonToggle ( String  text)

Constructs a ButtonToggle with the specified text.

Parameters
textButton text as java.lang.String.

Member Function Documentation

◆ getFont()

Font com.spvessel.spacevil.ButtonToggle.getFont ( )

Getting the current font of the text.

Returns
Font as java.awt.Font.

◆ getForeground()

Color com.spvessel.spacevil.ButtonToggle.getForeground ( )

Getting current text color.

Returns
Text color as as java.awt.Color.

◆ getText()

String com.spvessel.spacevil.ButtonToggle.getText ( )

Getting the current text of the ButtonToggle.

Returns
Text as java.lang.String.

◆ getTextHeight()

int com.spvessel.spacevil.ButtonToggle.getTextHeight ( )

Getting the text height (useful when you need resize ButtonToggle by text height).

Returns
Text height.

◆ getTextMargin()

Indents com.spvessel.spacevil.ButtonToggle.getTextMargin ( )

Getting indents of the text.

Returns
Indents as com.spvessel.spacevil.Decorations.Indents.

◆ getTextWidth()

int com.spvessel.spacevil.ButtonToggle.getTextWidth ( )

Getting the text width (useful when you need resize ButtonToggle by text width).

Returns
Text width.

◆ initElements()

void com.spvessel.spacevil.ButtonToggle.initElements ( )

Initializing text in the ButtonToggle.

Notice: This method is mainly for overriding only. SpaceVIL calls this method if necessary and no need to call it manually.

Reimplemented from com.spvessel.spacevil.Prototype.

◆ isToggled()

boolean com.spvessel.spacevil.ButtonToggle.isToggled ( )

Returns True if this button is toggled otherwise returns False.

Returns
True: this item is toggled. False: this item is untoggled.

◆ release()

void com.spvessel.spacevil.ButtonToggle.release ( )

Disposing ButtonToggle resources if the item was removed.

Notice: This method is mainly for overriding only. SpaceVIL calls this method if necessary and no need to call it manually.

Reimplemented from com.spvessel.spacevil.Prototype.

◆ setFont()

void com.spvessel.spacevil.ButtonToggle.setFont ( Font  font)

Setting font of the text.

Parameters
fontFont as java.awt.Font.

◆ setFontFamily()

void com.spvessel.spacevil.ButtonToggle.setFontFamily ( String  fontFamily)

Setting new font family of the text.

Parameters
fontFamilyNew font family name.

◆ setFontSize()

void com.spvessel.spacevil.ButtonToggle.setFontSize ( int  size)

Setting font size of the text.

Parameters
sizeNew size of the font.

◆ setFontStyle()

void com.spvessel.spacevil.ButtonToggle.setFontStyle ( int  style)

Setting font style of the text.

Parameters
styleNew font style (from java.awt.Font package).

◆ setForeground() [1/5]

void com.spvessel.spacevil.ButtonToggle.setForeground ( Color  color)

Setting text color of a ButtonToggle.

Parameters
colorText color as java.awt.Color.

◆ setForeground() [2/5]

void com.spvessel.spacevil.ButtonToggle.setForeground ( float  r,
float  g,
float  b 
)

Setting text color of a ButtonToggle in float RGB format.

Parameters
rRed color component. Range: (0.0f - 1.0f)
gGreen color component. Range: (0.0f - 1.0f)
bBlue color component. Range: (0.0f - 1.0f)

◆ setForeground() [3/5]

void com.spvessel.spacevil.ButtonToggle.setForeground ( float  r,
float  g,
float  b,
float  a 
)

Setting text color of a ButtonToggle in float RGBA format.

Parameters
rRed color component. Range: (0.0f - 1.0f)
gGreen color component. Range: (0.0f - 1.0f)
bBlue color component. Range: (0.0f - 1.0f)
aAlpha color component. Range: (0.0f - 1.0f)

◆ setForeground() [4/5]

void com.spvessel.spacevil.ButtonToggle.setForeground ( int  r,
int  g,
int  b 
)

Setting text color of a ButtonToggle in byte RGB format.

Parameters
rRed color component. Range: (0 - 255)
gGreen color component. Range: (0 - 255)
bBlue color component. Range: (0 - 255)

◆ setForeground() [5/5]

void com.spvessel.spacevil.ButtonToggle.setForeground ( int  r,
int  g,
int  b,
int  a 
)

Setting background color of an item in byte RGBA format.

Parameters
rRed color component. Range: (0 - 255)
gGreen color component. Range: (0 - 255)
bBlue color component. Range: (0 - 255)
aAlpha color component. Range: (0 - 255)

◆ setStyle()

void com.spvessel.spacevil.ButtonToggle.setStyle ( Style  style)

Setting style of the ButtonToggle.

Parameters
styleStyle as com.spvessel.spacevil.Decorations.Style.

Reimplemented from com.spvessel.spacevil.Prototype.

◆ setText()

void com.spvessel.spacevil.ButtonToggle.setText ( String  text)

Setting the text.

Parameters
textText as java.lang.String.

◆ setTextAlignment() [1/2]

void com.spvessel.spacevil.ButtonToggle.setTextAlignment ( ItemAlignment...  alignment)

Setting alignment of a ButtonToggle text.

Combines with alignment by vertically (TOP, VCENTER, BOTTOM) and horizontally (LEFT, HCENTER, RIGHT).

Parameters
alignmentText alignment as com.spvessel.spacevil.Flags.ItemAlignment.

◆ setTextAlignment() [2/2]

void com.spvessel.spacevil.ButtonToggle.setTextAlignment ( List< ItemAlignment alignment)

Setting alignment of a ButtonToggle text.

Combines with alignment by vertically (TOP, VCENTER, BOTTOM) and horizontally (LEFT, HCENTER, RIGHT).

Parameters
alignmentText alignment as List of com.spvessel.spacevil.Flags.ItemAlignment.

◆ setTextMargin() [1/2]

void com.spvessel.spacevil.ButtonToggle.setTextMargin ( Indents  margin)

Setting indents for the text to offset text relative to ButtonToggle.

Parameters
marginIndents as com.spvessel.spacevil.Decorations.Indents.

◆ setTextMargin() [2/2]

void com.spvessel.spacevil.ButtonToggle.setTextMargin ( int  left,
int  top,
int  right,
int  bottom 
)

Setting indents for the text to offset text relative to ButtonToggle.

Parameters
leftIndent on the left.
topIndent on the top.
rightIndent on the right.
bottomIndent on the bottom.

◆ setToggled()

void com.spvessel.spacevil.ButtonToggle.setToggled ( boolean  value)

Toggles this button between on or off.

Parameters
valueTrue: if you want this item to be toggled. False: if you want this item to be untoggled.

Member Data Documentation

◆ eventToggle

EventMouseMethodState com.spvessel.spacevil.ButtonToggle.eventToggle = new EventMouseMethodState()

Event that is invoked when a button toggles.


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