|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.as400.opnav.TBButtonDescriptor
A data entity which describes a Windows toolbar button.
A TBButtonDescriptor
contains a set of fields
which correspond to the Windows TBBUTTON
data structure.
An array of TBButtonDescriptor
s is included in the
WindowsToolBarInfo
instance returned by a component's
implementation of WindowsListManager.getWindowsToolBarInfo
.
WindowsToolBarInfo
,
WindowsListManager
Field Summary | |
static int |
CANCEL_BUTTON
The button is the public framework cancel button. |
static int |
COPY_BUTTON
The button is the public framework copy button. |
static int |
CUT_BUTTON
The button is the public framework cut button. |
static int |
DELETE_BUTTON
The button is the public framework delete button. |
static int |
PASTE_BUTTON
The button is the public framework paste button. |
static int |
PRINT_BUTTON
The button is the public framework print button. |
static int |
PROPERTIES_BUTTON
The button is the public framework properties button. |
static int |
REFRESH_BUTTON
The button is the public framework refresh button. |
static byte |
STATE_ENABLED
Indicates the button accepts user input. |
static byte |
STATE_HIDDEN
Indicates the button is not visible and cannot receive user input. |
static byte |
STATE_INDETERMINATE
Indicates the button is grayed. |
Constructor Summary | |
TBButtonDescriptor()
Constructs a button descriptor which acts as a separator. |
|
TBButtonDescriptor(int imageIndex,
int command,
byte state,
java.lang.String verb)
Constructs a button descriptor. |
Method Summary | |
int |
getCommand()
Returns the command identifier associated with this button. |
int |
getImageIndex()
Returns the index of the button image. |
byte |
getState()
Returns the state flags for this button. |
java.lang.String |
getVerb()
Returns the verb string used to identify the button programmatically. |
void |
setCommand(int command)
Sets the command identifier associated with this button. |
void |
setImageIndex(int index)
Sets the index of the button image. |
void |
setState(byte state)
Sets the state flags for this button. |
void |
setVerb(java.lang.String verb)
Sets the verb string used to identify the button programmatically. |
java.lang.String |
toString()
Returns a string representation of the object. |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Field Detail |
public static final int REFRESH_BUTTON
public static final int COPY_BUTTON
public static final int PASTE_BUTTON
public static final int DELETE_BUTTON
public static final int PROPERTIES_BUTTON
public static final int CUT_BUTTON
public static final int CANCEL_BUTTON
public static final int PRINT_BUTTON
public static final byte STATE_ENABLED
public static final byte STATE_HIDDEN
public static final byte STATE_INDETERMINATE
Constructor Detail |
public TBButtonDescriptor()
public TBButtonDescriptor(int imageIndex, int command, byte state, java.lang.String verb)
imageIndex
- Zero-based index of the button image.command
- Command identifier associated with this button.state
- Specify STATE_ENABLED, STATE_HIDDEN, or STATE_INDETERMINATE.verb
- The verb string used to identify the button programmatically.setCommand(int)
Method Detail |
public int getImageIndex()
public void setImageIndex(int index)
index
- The zero-based index of the button image.public int getCommand()
public void setCommand(int command)
command
- The integer identifier associated with this button.
This value can also be CANCEL_BUTTON, DELETE_BUTTON,
PRINT_BUTTON, REFRESH_BUTTON, CUT_BUTTON, COPY_BUTTON,
PASTE_BUTTON or PROPERTIES_BUTTON.public byte getState()
public void setState(byte state)
state
- One of the three flags STATE_ENABLED, STATE_HIDDEN, or STATE_INDETERMINATE.public java.lang.String getVerb()
public void setVerb(java.lang.String verb)
verb
- The verb string associated with this button.public java.lang.String toString()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |