Remove the component from rendering.
If the Component supports it, this can be reverted with restore() method.
Object itself for fluent interface.
Get elements Background object
Type of Background is generic, see UIBackground for minimum interface.
Background object
True for highlighted state of object and false for basic
Get margin around object in pixels.
Margin datastructure
Mouse interactions state
Get mouse style.
Interface for defining how mouse should look when hovering over UI object
Get padding around object in pixels. Padding is empty space between the UiElements content and Background
Margin datastructure
Get the text of the entire shape.
The entire text string.
Current text fill style object
Get font of Label.
FontSettings
Get rotation of Label.
Rotation in degrees
True if the component is currently disposed, and thus not being rendered. If the Component supports it, this can be reverted with restore() method.
Unsubscribe from Highlight object event. This is called whenever an object is highlighted
Token that was received when subscribing to the event.
True if the unsubscription was successful.
Remove event listener from Mouse Click Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Double Click Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Down Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Drag Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Drag start Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Drag stop Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Enter Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Leave Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Move Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Up Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Mouse Wheel Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Touch End Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Touch Move Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Remove event listener from Touch Start Event
Token of event listener which has to be removed
True if the listener is successfully removed and false if it is not found
Subscribe to highlight object event. This is called whenever an object is highlighted.
Function that is called when event is triggered.
Token that can be used to unsubscribe from the event.
Subscribe on Mouse Enter click
Event handler function
Token of subscription
Subscribe to Mouse Double Click event
Event handler function
Token of subscription
Subscribe to Mouse Down event
Event handler function
Token of subscription
Subscribe to Mouse Drag event
Event handler function
Token of subscription
Subscribe to Mouse Drag Start event
Event handler function
Token of subscription
Subscribe to Mouse Drag Stop event
Event handler function
Token of subscription
Subscribe on Mouse Enter event
Event handler function
Token of subscription
Subscribe on Mouse Enter leave
Event handler function
Token of subscription
Subscribe to Mouse Move event
Event handler function
Token of subscription
Subscribe to Mouse Up event
Event handler function
Token of subscription
Subscribe to Mouse Wheel event
Event handler function
Token of subscription
Subscribe to Touch End event
Event handler function
Token of subscription
Subscribe to Touch Move event
Event handler function
Token of subscription
Subscribe to Touch Start event
Event handler function
Token of subscription
After the Components dispose() method has been called, removing it from rendering, restore() can be used to return it back.
Object itself for fluent interface.
Method for mutating Background of object.
Type of Background is generic, see UIBackground for minimum interface.
Mutator function for Background
Object itself for fluent interface
Set highlighted state of the Object
Highlight state of the object
Object itself for fluent interface
Set margin around object in pixels.
Number with pixel margins for all sides or datastructure with individual pixel margins for each side. Any side can be omitted, only passed values will be overridden.
Object itself
Set mouse interactions enabled or disabled
Specifies state of mouse interactions
Object itself for fluent interface
Set mouse style when hovering over UI object.
Interface for defining how mouse should look when hovering over UI object
Object itself
Set padding around object in pixels. Padding is empty space between the UiElements content and Background
Number with pixel margins for all sides or datastructure with individual pixel paddings for each side. Any side can be omitted, only passed values will be overridden.
Object itself
Set the text of the entire shape.
Text string.
Set text fill style object
Fill style object or function which modifies it
Object itself for fluent interface
Set font of Label.
FontSettings or mutator function for existing settings
Object itself
Set rotation of Label.
Object itself
Interface for 'TextBox'.