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.TabView Class Reference

TabView is a special container designed to group items within specific tab page. More...

Inherits com.spvessel.spacevil.VerticalStack.

Public Member Functions

void setTabPolicy (SizePolicy policy)
 Setting the width policy of tabs. More...
 
SizePolicy getTabPolicy ()
 Getting the current width policy of tabs. More...
 
List< TabgetTabs ()
 Getting all existing tabs in TabView. More...
 
 TabView ()
 Default TabView constructor. More...
 
void initElements ()
 Initializing all elements in the TabView. More...
 
void selectTab (Tab tab)
 Selecting a tab by its Tab instance. More...
 
void selectTab (int index)
 Selecting a tab by its index. More...
 
void selectTabByName (String tabName)
 Selecting a tab by its name. More...
 
void selectTabByText (String tabText)
 Selecting a first-found tab by its text. More...
 
int getSelectedTabIndex ()
 Getting the index of the current selected tab. More...
 
Tab getSelectedTab ()
 Getting the current selected tab. More...
 
Frame getTabFrame (Tab tab)
 Getting a page of a tab. More...
 
List< InterfaceBaseItemgetTabContent (Tab tab)
 Getting content of a page by its tab. More...
 
void addTab (Tab tab)
 Adding a new tab to the TabView. More...
 
void addTabs (Tab... tabs)
 Adding new tabs to the TabView. More...
 
boolean removeItem (InterfaceBaseItem item)
 Removing the specified item from TabView. More...
 
boolean removeTabByName (String tabName)
 Removing a tab by its name. More...
 
boolean removeTabByText (String tabText)
 Removing a first-found tab by its text. More...
 
boolean removeTab (Tab tab)
 Removing a tab. More...
 
boolean removeAllTabs ()
 Removing all existing tabs. More...
 
void addItemToTabByName (String tabName, InterfaceBaseItem item)
 Adding an item to page by its tab name. More...
 
void addItemToTabByText (String tabText, InterfaceBaseItem item)
 Adding an item to page by its tab text. More...
 
void addItemToTab (Tab tab, InterfaceBaseItem item)
 Adding an item to page by its tab. More...
 
void setStyle (Style style)
 Setting style of the TabView. More...
 
- Public Member Functions inherited from com.spvessel.spacevil.VerticalStack
void setContentAlignment (ItemAlignment alignment)
 Setting content alignment within VerticalStack area. More...
 
ItemAlignment getContentAlignment ()
 Getting current content alignment. More...
 
 VerticalStack ()
 Default VerticalStack constructor. More...
 
void addItem (InterfaceBaseItem item)
 Adding item to the VerticalStack. More...
 
void insertItem (InterfaceBaseItem item, int index)
 Inserting item to the VerticalStack container. More...
 
void setHeight (int height)
 Setting VerticalStack height. More...
 
void setY (int y)
 Setting Y coordinate of the left-top corner of the VerticalStack. More...
 
void updateLayout ()
 Updating all children positions (implementation of com.spvessel.spacevil.Core.InterfaceVLayout). More...
 
- Public Member Functions inherited from com.spvessel.spacevil.Prototype
 Prototype ()
 Default constructor of Prototype class. More...
 
void release ()
 Method to describe disposing item's resources if the item was removed. 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...
 
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...
 
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...
 
void clear ()
 Removing all children. More...
 
void addItems (InterfaceBaseItem... items)
 Adding sequence of items 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...
 

Protected Member Functions

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

Additional Inherited Members

- 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...
 

Detailed Description

TabView is a special container designed to group items within specific tab page.

TabView cannot receive any events, so TabView is always in the com.spvessel.spacevil.Flags.ItemStateType.BASE state.

Constructor & Destructor Documentation

◆ TabView()

com.spvessel.spacevil.TabView.TabView ( )

Default TabView constructor.

Member Function Documentation

◆ addItemToTab()

void com.spvessel.spacevil.TabView.addItemToTab ( Tab  tab,
InterfaceBaseItem  item 
)

Adding an item to page by its tab.

Parameters
tabTab as com.spvessel.spacevil.Tab.
itemItem as com.spvessel.spacevil.Core.InterfaceBaseItem.

◆ addItemToTabByName()

void com.spvessel.spacevil.TabView.addItemToTabByName ( String  tabName,
InterfaceBaseItem  item 
)

Adding an item to page by its tab name.

Tab name is ID of UI element. Tab name is uniq but tab text is not.

Explanation: the tab text can be a web address, and there can be several open tabs with the same address.

Parameters
tabNameTab name.
itemItem as com.spvessel.spacevil.Core.InterfaceBaseItem.

◆ addItemToTabByText()

void com.spvessel.spacevil.TabView.addItemToTabByText ( String  tabText,
InterfaceBaseItem  item 
)

Adding an item to page by its tab text.

Tab name is ID of UI element. Tab name is uniq but tab text is not.

Explanation: the tab text can be a web address, and there can be several open tabs with the same address.

Parameters
tabTextTab text.
itemItem as com.spvessel.spacevil.Core.InterfaceBaseItem.

◆ addTab()

void com.spvessel.spacevil.TabView.addTab ( Tab  tab)

Adding a new tab to the TabView.

Parameters
tabThe new tab as com.spvessel.spacevil.Tab.

◆ addTabs()

void com.spvessel.spacevil.TabView.addTabs ( Tab...  tabs)

Adding new tabs to the TabView.

Parameters
tabsTab sequence as com.spvessel.spacevil.Tab.

◆ getHoverVerification()

boolean com.spvessel.spacevil.TabView.getHoverVerification ( float  xpos,
float  ypos 
)
protected

◆ getSelectedTab()

Tab com.spvessel.spacevil.TabView.getSelectedTab ( )

Getting the current selected tab.

Returns
Current selected tab as com.spvessel.spacevil.Tab.

◆ getSelectedTabIndex()

int com.spvessel.spacevil.TabView.getSelectedTabIndex ( )

Getting the index of the current selected tab.

Returns
Index of the current selected tab.

◆ getTabContent()

List<InterfaceBaseItem> com.spvessel.spacevil.TabView.getTabContent ( Tab  tab)

Getting content of a page by its tab.

Parameters
tabTab as com.spvessel.spacevil.Tab.
Returns
Page content as List<com.spvessel.spacevil.Core.InterfaceBaseItem>.

◆ getTabFrame()

Frame com.spvessel.spacevil.TabView.getTabFrame ( Tab  tab)

Getting a page of a tab.

Parameters
tabTab as com.spvessel.spacevil.Tab.
Returns
Page of a tab as com.spvessel.spacevil.Frame.

◆ getTabPolicy()

SizePolicy com.spvessel.spacevil.TabView.getTabPolicy ( )

Getting the current width policy of tabs.

Can be FIXED (tab shape not changes its size) or EXPAND (tab shape is stretched to all available space).

Returns
Width policy of tab shapes.

◆ getTabs()

List<Tab> com.spvessel.spacevil.TabView.getTabs ( )

Getting all existing tabs in TabView.

Returns
Tabs as List<com.spvessel.spacevil.Tab>.

◆ initElements()

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

Initializing all elements in the TabView.

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.

◆ removeAllTabs()

boolean com.spvessel.spacevil.TabView.removeAllTabs ( )

Removing all existing tabs.

Returns
True: if the removal was successful. False: if the removal was unsuccessful.

◆ removeItem()

boolean com.spvessel.spacevil.TabView.removeItem ( InterfaceBaseItem  item)

Removing the specified item from TabView.

Parameters
itemItem as com.spvessel.spacevil.Core.InterfaceBaseItem.
Returns
True: if the removal was successful. False: if the removal was unsuccessful.

Reimplemented from com.spvessel.spacevil.VerticalStack.

◆ removeTab()

boolean com.spvessel.spacevil.TabView.removeTab ( Tab  tab)

Removing a tab.

Parameters
tabTab as com.spvessel.spacevil.Tab.
Returns
True: if the removal was successful. False: if the removal was unsuccessful.

◆ removeTabByName()

boolean com.spvessel.spacevil.TabView.removeTabByName ( String  tabName)

Removing a tab by its name.

Tab name is ID of UI element. Tab name is uniq but tab text is not.

Explanation: the tab text can be a web address, and there can be several open tabs with the same address.

Parameters
tabNameTab name.
Returns
True: if the removal was successful. False: if the removal was unsuccessful.

◆ removeTabByText()

boolean com.spvessel.spacevil.TabView.removeTabByText ( String  tabText)

Removing a first-found tab by its text.

Tab name is ID of UI element. Tab name is uniq but tab text is not.

Explanation: the tab text can be a web address, and there can be several open tabs with the same address.

Parameters
tabTextTab text.
Returns
True: if the removal was successful. False: if the removal was unsuccessful.

◆ selectTab() [1/2]

void com.spvessel.spacevil.TabView.selectTab ( int  index)

Selecting a tab by its index.

If index is out of range then this method does nothing.

Parameters
indexIndex of a tab.

◆ selectTab() [2/2]

void com.spvessel.spacevil.TabView.selectTab ( Tab  tab)

Selecting a tab by its Tab instance.

Parameters
tabTab to select.

◆ selectTabByName()

void com.spvessel.spacevil.TabView.selectTabByName ( String  tabName)

Selecting a tab by its name.

Tab name is ID of UI element. Tab name is uniq but tab text is not.

Explanation: the tab text can be a web address, and there can be several open tabs with the same address.

Parameters
tabNameTab name.

◆ selectTabByText()

void com.spvessel.spacevil.TabView.selectTabByText ( String  tabText)

Selecting a first-found tab by its text.

Tab name is ID of UI element. Tab name is uniq but tab text is not.

Explanation: the tab text can be a web address, and there can be several open tabs with the same address.

Parameters
tabTextTab text.

◆ setStyle()

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

Setting style of the TabView.

Inner styles: Inner styles: "tabbar", "viewarea".

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

Reimplemented from com.spvessel.spacevil.Prototype.

◆ setTabPolicy()

void com.spvessel.spacevil.TabView.setTabPolicy ( SizePolicy  policy)

Setting the width policy of tabs.

Can be FIXED (tab shape not changes its size) or EXPAND (tab shape is stretched to all available space).

Parameters
policyWidth policy of tab shapes.

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