List
Anthony Ma edited this page May 26, 2015
·
5 revisions
Clone this wiki locally
A list stores buttons and labels and allows you to scroll through them. A list should only hold buttons and labels and may not work correctly with other components. #Fields
-
xdefault: 1 - x value of the component -
ydefault: 1 - y value of the component -
hdefault: 1 - height of the component -
wdefault: 16 - width of the component -
zdefault: 0 - z value of the component -
parent- parent window object of the component -
removed- whether the component has been queued for removal - should only be modified by the library itself -
visibledefault: true - whether the component is visible -
bgColordefault: colors.white - the background color -
bgColorStripedefault: colors.lightGray - the background color of the striped elements -
textColordefault: colors.black - the color of the text -
textColorStripedefault: colors.gray - the color of the text in the striped elements -
activeColordefault: colors.gray - the color if the element active - only applies if the element is a button -
activeTextColordefault: colors.white - the color of the text if the element active - only applies if the element is a button -
textAligndefault: "center" - alignment of the text -
scrollBarColordefault: colors.gray - color of the scroll bar -
scrollBarTextColordefault: colors.white - color of the arrows on the scroll bar -
scrollBardefault: true - whether the scroll bar is displayed -
displayOffsetdefault: 0 - offset for displaying the elements in the list - should only be modified by the library itself -
components- table of all components - should only be modified by the library itself
#Functions
-
function draw(self)- draws the label - should only be called by the library itself -
function click(self, x, y)- called by the library on a click event to pass the event along to the elements of the list -
function scroll(self, direction)- called by the library on a scroll event to scroll through the list if the list is the active component -
function addComponent(self, componentTbl)- adds a component to the list - must be a label or button -
function update(self)- called every update cycle -
function termX(self)- returns the x position on the terminal -
function termY(self)- returns the y position on the terminal -
function setPos(self, x, y)- sets the position of the component -
function setSize(self, w, h)- sets the size of the component