All Packages Class Hierarchy This Package Previous Next Index
Class com.ibm.as400.ui.framework.java.ItemDescriptor
java.lang.Object
|
+----com.ibm.as400.ui.framework.java.ItemDescriptor
- public class ItemDescriptor
- extends Object
- implements SwingConstants
Describes an item in a list.
ItemDescriptor
s represent objects on a
user interface panel, as displayed in a list or table.
-
ItemDescriptor()
- Constructs an
ItemDescriptor
.
-
ItemDescriptor(String, String)
- Constructs an
ItemDescriptor
with the specified
name and title.
-
ItemDescriptor(String, String, HandlerTask[])
- Constructs an
ItemDescriptor
with the specified
name, title, and HandlerTask
list.
-
ItemDescriptor(String, String, String)
- Constructs an
ItemDescriptor
with the specified
name, title and image file.
-
ItemDescriptor(String, String, String, int, int)
- Constructs an
ItemDescriptor
with the specified
name, title, image file, and icon alignment.
-
addHandlerTask(HandlerTask)
- Adds a
HandlerTask
to the item.
-
getHorizontalIconPosition()
- Returns the item's horizontal icon position.
-
getImageFile()
- Returns the item's image file name.
-
getName()
- Returns the item name.
-
getTitle()
- Returns the item title.
-
getVerticalIconPosition()
- Returns the item's vertical icon position.
-
removeHandlerTask(HandlerTask)
- Removes a
HandlerTask
from the item.
-
setHorizontalIconPosition(int)
- Sets the item's horizontal icon position.
-
setImageFile(String)
- Sets the item's image file name.
-
setName(String)
- Sets the item name.
-
setTitle(String)
- Sets the item title.
-
setVerticalIconPosition(int)
- Sets the item's vertical icon position.
-
toString()
- Returns a string representation of the item.
ItemDescriptor
public ItemDescriptor()
- Constructs an
ItemDescriptor
.
ItemDescriptor
public ItemDescriptor(String name,
String title)
- Constructs an
ItemDescriptor
with the specified
name and title.
- Parameters:
- name - the name that is used to identify the item programmatically
- title - the title of the item in a form suitable for displaying to the user
ItemDescriptor
public ItemDescriptor(String name,
String title,
String imageFile)
- Constructs an
ItemDescriptor
with the specified
name, title and image file.
Default icon position of LEFT and vertical icon position of CENTER will be used.
- Parameters:
- name - the name that is used to identify the item programmatically
- title - the title of the item in a form suitable for displaying to the user
ItemDescriptor
public ItemDescriptor(String name,
String title,
String imageFile,
int iconPosition,
int vIconPosition)
- Constructs an
ItemDescriptor
with the specified
name, title, image file, and icon alignment.
- Parameters:
- name - the name that is used to identify the item programmatically
- title - the title of the item in a form suitable for displaying to the user
ItemDescriptor
public ItemDescriptor(String name,
String title,
HandlerTask handlerTasks[])
- Constructs an
ItemDescriptor
with the specified
name, title, and HandlerTask
list.
- Parameters:
- name - the name that is used to identify the item programmatically
- title - the title of the item in a form suitable for displaying to the user
- handlerTasks - a list of
HandlerTask
s which describe to
the UI framework actions which should be carried out when the item is selected
- See Also:
- HandlerTask
getName
public String getName()
- Returns the item name.
- Returns:
- a string which is used to identify the item programmatically
- See Also:
- setName
setName
public void setName(String name)
- Sets the item name.
- Parameters:
- name - a string which is used to identify the item programmatically
- See Also:
- getName
getTitle
public String getTitle()
- Returns the item title.
- Returns:
- the string which is displayed to the user
- See Also:
- setTitle
setTitle
public void setTitle(String title)
- Sets the item title.
- Parameters:
- title - the string which is displayed to the user
- See Also:
- getTitle
getImageFile
public String getImageFile()
- Returns the item's image file name.
- Returns:
- the name of the image resource that will be used to
create the icon for the item
- See Also:
- setImageFile
setImageFile
public void setImageFile(String imageFile)
- Sets the item's image file name.
- Parameters:
- imageFile - the name of the image resource that will be used to
create the icon for the item
- See Also:
- getImageFile
getHorizontalIconPosition
public int getHorizontalIconPosition()
- Returns the item's horizontal icon position.
- Returns:
- the horizontal position of the icon for the item
- See Also:
- setHorizontalIconPosition
setHorizontalIconPosition
public void setHorizontalIconPosition(int horizontalIconPosition)
- Sets the item's horizontal icon position.
- Parameters:
- horizontalIconPosition - the horizontal position of the icon for the item
- See Also:
- getHorizontalIconPosition
getVerticalIconPosition
public int getVerticalIconPosition()
- Returns the item's vertical icon position.
- Returns:
- the vertical position of the icon for the item
- See Also:
- setVerticalIconPosition
setVerticalIconPosition
public void setVerticalIconPosition(int verticalIconPosition)
- Sets the item's vertical icon position.
- Parameters:
- verticalIconPosition - the vertical position of the icon for the item
- See Also:
- getVerticalIconPosition
addHandlerTask
public void addHandlerTask(HandlerTask task)
- Adds a
HandlerTask
to the item.
A HandlerTask
is an action that should be performed
by the UI framework when the item is selected.
- Parameters:
- task - the task to be performed
- See Also:
- removeHandlerTask, HandlerTask
removeHandlerTask
public void removeHandlerTask(HandlerTask task)
- Removes a
HandlerTask
from the item.
If the specified HandlerTask
is not associated
with the item, no action occurs.
- Parameters:
- task - the task to be removed
- See Also:
- addHandlerTask, HandlerTask
toString
public String toString()
- Returns a string representation of the item.
The string is in a form suitable for displaying to the user.
- Returns:
- the item as a string
- Overrides:
- toString in class Object
All Packages Class Hierarchy This Package Previous Next Index