Package com.scriptel.proscript
Class RegionButton
- java.lang.Object
-
- com.scriptel.proscript.Region
-
- com.scriptel.proscript.RegionButton
-
public final class RegionButton extends Region
This class represents a button region.
-
-
Constructor Summary
Constructors Constructor Description RegionButton()Public constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(java.lang.Object o)intgetButtonReserved()Reserved for future use.java.lang.StringgetCaption()Gets the caption on this button.intgetParent()Gets the parent region of this button.intgetResourceNumberNormal()Gets the resource number of the button in an idle state.intgetResourceNumberSelected()Gets the resource number of the button in a selected state.booleangetUseResource()Gets whether or not resources are being used on this button.inthashCode()booleanisEnabled()Whether or not this button is enabled.voidsetButtonReserved(int buttonReserved)Reserved for future use.voidsetCaption(java.lang.String caption)Sets the caption on this button.voidsetClearOnSelect(boolean clearOnSelect)Sets whether or not this button clears on select.voidsetConfirmOnSelect(boolean confirmOnSelect)Sets whether or not this button confirms on select.voidsetEnabled(boolean enable)Sets whether or not this button is enabled.voidsetHighlightOnSelect(boolean highlightOnSelect)Sets whether or not this button highlights on select.voidsetParent(int parent)Sets the parent region of this button.voidsetResourceNumberNormal(int resourceNumberNormal)Sets the resource number of the button in an idle state.voidsetResourceNumberSelected(int resourceNumberSelected)Sets the resource number of the button in a selected state.voidsetUseResource(boolean useResource)Sets whether or not resources are being used on this button.java.lang.StringtoString()Prints this object as a human readable string.booleanwillClearOnSelect()Gets whether or not this button clears on select.booleanwillConfirmOnSelect()Gets whether or not this button confirms on select.booleanwillHighlightOnSelect()Sets whether or not this button highlights on select.-
Methods inherited from class com.scriptel.proscript.Region
acceptsTouch, getColorBackground, getColorForeground, getNumber, getOutputToHost, getReserved2, getX1, getX2, getY1, getY2, hasFrame, isDecode, isInUse, isReserved1, isVisible, setAcceptTouch, setColorBackground, setColorForeground, setDecode, setHasFrame, setInUse, setNumber, setOutputToHost, setReserved1, setReserved2, setVisible, setX1, setX2, setY1, setY2
-
-
-
-
Method Detail
-
toString
public java.lang.String toString()
Prints this object as a human readable string.
-
getParent
public int getParent()
Gets the parent region of this button.- Returns:
- the parent
-
setParent
public void setParent(int parent)
Sets the parent region of this button.- Parameters:
parent- the parent to set
-
isEnabled
public boolean isEnabled()
Whether or not this button is enabled.- Returns:
- the enable
-
setEnabled
public void setEnabled(boolean enable)
Sets whether or not this button is enabled.- Parameters:
enable- the enable to set
-
willHighlightOnSelect
public boolean willHighlightOnSelect()
Sets whether or not this button highlights on select.- Returns:
- the highlightOnSelect
-
setHighlightOnSelect
public void setHighlightOnSelect(boolean highlightOnSelect)
Sets whether or not this button highlights on select.- Parameters:
highlightOnSelect- the highlightOnSelect to set
-
willClearOnSelect
public boolean willClearOnSelect()
Gets whether or not this button clears on select.- Returns:
- the clearOnSelect
-
setClearOnSelect
public void setClearOnSelect(boolean clearOnSelect)
Sets whether or not this button clears on select.- Parameters:
clearOnSelect- the clearOnSelect to set
-
willConfirmOnSelect
public boolean willConfirmOnSelect()
Gets whether or not this button confirms on select.- Returns:
- the clearOnSelect
-
setConfirmOnSelect
public void setConfirmOnSelect(boolean confirmOnSelect)
Sets whether or not this button confirms on select.- Parameters:
confirmOnSelect- the confirmOnSelect to set
-
getUseResource
public boolean getUseResource()
Gets whether or not resources are being used on this button.- Returns:
- use resource
-
setUseResource
public void setUseResource(boolean useResource)
Sets whether or not resources are being used on this button.- Parameters:
useResource- use resource
-
getCaption
public java.lang.String getCaption()
Gets the caption on this button.- Returns:
- the caption
-
setCaption
public void setCaption(java.lang.String caption)
Sets the caption on this button.- Parameters:
caption- the caption to set
-
getResourceNumberNormal
public int getResourceNumberNormal()
Gets the resource number of the button in an idle state.- Returns:
- the resource number normal
-
setResourceNumberNormal
public void setResourceNumberNormal(int resourceNumberNormal)
Sets the resource number of the button in an idle state.- Parameters:
resourceNumberNormal- the resource number normal
-
getResourceNumberSelected
public int getResourceNumberSelected()
Gets the resource number of the button in a selected state.- Returns:
- resource number selected
-
setResourceNumberSelected
public void setResourceNumberSelected(int resourceNumberSelected)
Sets the resource number of the button in a selected state.- Parameters:
resourceNumberSelected- the resource number selected
-
getButtonReserved
public int getButtonReserved()
Reserved for future use.- Returns:
- the buttonReserved
-
setButtonReserved
public void setButtonReserved(int buttonReserved)
Reserved for future use.- Parameters:
buttonReserved- the buttonReserved to set
-
-