ComboBox (SAS AppDevStudio API Developer Documentation for Java)

public class ComboBox
implements com.sas.lang.StringDataInterface, com.sas.collection.ContentsChangedListener, ResizeToFitInterface, java.awt.ItemSelectable, com.sas.ViewDefaultModelInterface
implements com.sas.lang.StringDataInterface, com.sas.collection.ContentsChangedListener, ResizeToFitInterface, java.awt.ItemSelectable, com.sas.ViewDefaultModelInterface

ComboBox displays a list of items for selection and contains an optionally editable text control that allows the user to enter text that is not in the list portion of the comboBox.

Creation:

Create a ComboBox

ComboBox comboBox1 = new ComboBox();
comboBox1.initialize();

Default Size:

height = 23
width = 124

Required Interfaces:
The ComboBox requires a model that implements com.sas.collection.StaticOrderedCollectionInterface. A default model is automatically created and attached to the ComboBox when the ComboBox is initially constructed.

Notes:

The ComboBox implements the com.sas.collection.ContentsChangedListener, com.sas.visuals.ResizeToFitInterface, and com.sas.lang.StringData interfaces.
The resizeToFit property determines whether to change the size of the ComboBox when either the items in the list change or the font changes. If the resizeToFit property is set to true, changing the items or font may cause the Choice to expand or contract. The resizeToFit property is initially set to false. The resizeToFit property determines whether to change the size of the component when either the text or font changes. If the component is managed by a layout manager that uses preferred sizes, the component will behave as if the resizeToFit property has been set to true regardless of the actual value of the resizeToFit property.
Transforms are used when the information in the model needs to be changed to a different type to be used for output, input, or display.
The items in the list can be modified (additions, insertions, removals) only if the attached model supports modifications to the list.
Modifying Items in the ComboBox
- Items can be added to the end of the list through the addItem(Object item), add(Enumeration items), or add(Object[]) methods. A null item can be added to the list if a display transform is applied that returns a non-null value.
- An item can be inserted in the list through the addItem(Object, int index) method. A null item can be inserted into the list if a display transform is applied that returns a non-null value. Specifying an index less than -1 or an index that is greater than (current item count - 1) will result in a java.lang.IndexOutOfBoundsException being thrown.
- An item can be replaced in the list through the replaceItem(Object, int index) method. Specifying an index of less than 0 or an index that is greater than (current item count - 1) will result in a java.lang.IndexOutOfBoundsException to be thrown. An item can be replaced with a null if a display transform is applied that returns a non-null value.
- Items can be removed from the list through the removeItem(String item), removeItem(Object item),removeItem (int index) or removeAllItems() methods. Specifying an index of less than 0 or an index that is greater than (current item count - 1) will result in a java.lang.IndexOutOfBoundsException to be thrown. Specifying an item that is not in the list will result in a java.lang.IllegalArgumentException to be thrown.
The style property determines the behavior and appearance of the comboBox. The comboBox can have one of three styles:

DROPDOWN - can type entries in the text control as well as select entries
from the list portion

SIMPLE - similar to the DROPDOWN style in that entries can be typed in
the text control but the dropdown area is always displayed

DROPDOWNLIST - can only select entries from the list portion

NOTE: The default style is DROPDOWN. This value can be changed through the setStyle(int cstyle) method.

The autoHighlight property, when set to true, will cause the text in the component to be selected when the text component receives focus. Setting the autoHighlight property to true is honored only if the style is DROPDOWN or SIMPLE.

See Also:: Serialized Form

Field Summary

static int DROPDOWN


static int DROPDOWNLIST


com.sas.collection.OrderedListCollection excludedKeys


protected com.sas.visuals.ComboBoxFocusHandler focusHandler


java.awt.event.ItemListener itemListener


java.awt.event.KeyListener keyListener


int oldSelectedIndex


static java.lang.String RB_KEY


static int SIMPLE


boolean textOverride


Constructor Summary

ComboBox()
          Default constructor

Method Summary

void add(com.sas.Component comp)
          Adds the specified component to this container.

void add(com.sas.Component comp, int index)
          Adds the specified component to this container at the specified index.

void add(com.sas.Component comp, java.lang.Object constraints)
          Adds the specified component to this container with the specified constraints.

void add(com.sas.Component comp, java.lang.Object constraints, int index)
          Adds the specified component to this container with the specified constraints at the specified index.

void add(java.util.Enumeration items)
          Adds items to the end of the list if the attached model supports addition of items.

void add(java.lang.Object[] items)
          Adds items to the end of the list if the attached model supports addition of items.

void add(java.lang.String name, com.sas.Component comp)
          Adds the specified component to this container.

void addImpl(com.sas.Component comp, java.lang.Object constraints, int index)
          Adds the specified component to this container with the specified constraints at the specified index.

void addItem(java.lang.Object item)
          Adds an item to the end of the list if the attached model supports addition of items.

void addItem(java.lang.Object item, int index)
          Adds an item at the specified location if the attached model supports addition of items.

void addItemListener(java.awt.event.ItemListener l)
          Add a listener to receive item events when the state of an item changes.

void addKeyListener(java.awt.event.KeyListener l)
          Add a listener to receive key events

void addNotify()
          Notifies the component that it has been added to a container and that the peer should be created.

void attachModel(com.sas.ModelInterface model)
          Attaches a model to the component.

protected int calculateWindowHeight()
          Calculates the height of the window in which to display the dropdown items

java.awt.Dimension computePreferredSize()
          Returns the preferred size of the ComboBox

void contentsChanged(com.sas.collection.ContentsChangedEvent evt)
          Called when the contents of the Model have changed.

protected void createItemEvent(int changed, java.lang.String selItem, int selected)
          Processes item events by dispatching them to any registered ItemListener objects.

protected void createKeyEvent(int id, long when, int modifiers, int keyCode, char keyChar)
          Processes key events by dispatching them to any registered KeyListener objects.

void detachModel(com.sas.ModelInterface model)
          Detaches the current model and attaches the default model if the model is set to null

void displayList()
          Displays the list portion of the comboBox

static int getDefaultHeight()
          Returns the default height for instances of this class

static int getDefaultWidth()
          Returns the default width for instances of this class

com.sas.util.transforms.TransformInterface getDisplayTransform()
          Returns the display transform.

static com.sas.beans.ExtendedBeanInfo getExtendedBeanInfo()
          Returns the ExtendedBeanInfo for this class.

java.lang.String[] getInitialItems()
          Returns the initial items (an empty string array is returned if there are no initial items)

com.sas.util.transforms.TransformInterface getInputTransform()
          Returns the input transform.

java.awt.Dimension getMinimumSize()
          Returns the minimum size of the comboBox

com.sas.util.transforms.TransformInterface getOutputTransform()
          Returns the output transform.

java.util.Vector getRequiredInterfaces()
          Returns the required interfaces Vector for this component.

int getSelectedIndex()
          Returns the selected index

java.lang.String getSelectedItem()
          Returns the selectedItem

java.lang.Object[] getSelectedObjects()
          Returns the selected object.

int getStyle()
          Returns the style of the comboBox

java.lang.String getText()
          Returns the text

void hideList()
          Hide the list portion of the comboBox

void initialize()
          Draw comboBox according to style chosen

boolean isAddTextToList()
          Returns the value of the addTextToList property.

boolean isAutoHighlight()
          Returns the value of the autoHighlight property

boolean isDefaultModelAttached()
          Returns whether the default model is attached.

boolean isMatchedEntry()
          Returns the value of the matchedEntry property.

boolean isResizeToFit()
          Returns the value of the resizeToFit property.

protected com.sas.visuals.ComboButton newComboButton()


void refresh()
          Clears current items and add items obtained from the attached model

void refresh(com.sas.ModelInterface model)
          Clear current items and add items obtained from the attached model

void remove(com.sas.Component comp)
          Removes the specified component from this container.

void remove(int index)
          Removes the component at the specified index from this container.

void removeAll()
          Removes all the components from this container.

void removeAllItems()
          Removes all items

void removeItem(int index)
          Removes the item at the specified position if the attached model supports removal of items.

void removeItem(java.lang.Object item)
          Removes the first occurrence of item if the attached model supports removal of items.

void removeItem(java.lang.String item)
          Removes the first occurrence of item if the attached model supports removal of items.

void removeItemListener(java.awt.event.ItemListener l)
          Removes an item listener.

void removeKeyListener(java.awt.event.KeyListener l)
          Removes a key listener.

void replaceItem(java.lang.Object newvalue, int index)
          Replaces an item if the attached model supports replacement of items.

void requestFocus()
          Overridden in order to select the text in the textField if the autoHighlight property is true and the style is not DROPDOWNLIST

void selectedItem(java.lang.Object text)
          Set the selected item to the specified object.

void setAddTextToList(boolean state)
          Sets the specified boolean to indicate whether text entries should be added to the list.

void setAutoHighlight(boolean value)
          Sets the specified boolean to indicate whether or not all text in the component will be selected when the component receives focus.

void setBackgroundColor(java.awt.Color color)
          Sets the background color

void setBounds(int x, int y, int width, int height)
          Reshapes the Component to the specified bounding box.

static void setDefaultHeight(int newDefaultHeight)
          Sets the default height of the component.

void setDefaultValues()
          Sets the initial values to the default values.

static void setDefaultWidth(int newDefaultWidth)
          Sets the default width of the component.

void setDisplayTransform(com.sas.util.transforms.TransformInterface transform)
          Sets the display transform.

void setEnabled(boolean value)
          Sets the enabled property

void setFont(java.awt.Font font)
          Sets the font

void setForeground(java.awt.Color color)
          Sets the foreground color

void setForegroundColor(java.awt.Color color)
          Sets the foreground color

void setInitialItems(java.lang.String[] items)
          Sets the initial items

void setInputTransform(com.sas.util.transforms.TransformInterface transform)
          Sets the input Transform.

void setMatchedEntry(boolean state)
          Sets the value of the matchedEntry property.

void setOutputTransform(com.sas.util.transforms.TransformInterface transform)
          Sets the output Transform.

void setResizeToFit(boolean value)
          Sets the value of the resizeToFit property The resizeToFit property determines whether to change the size of the component when either the text or font changes.

void setSelectedIndex(int index)
          Sets the selected index

void setSelectedItem(java.lang.String text)
          Sets the selected item

void setStyle(int cstyle)
          Sets the style of the comboBox

void setText(java.lang.String text)
          Sets the text to the specified text

Methods inherited from class com.sas.awt.Panel

remove

Methods inherited from class com.sas.awt.PanelContainerComponent

clone, dragEnter, dragLeave, dragOver, drop, getContainerInterfaceSupportInfo, getErrorHandler, getInsets, getValidator, isIDEDnDDropBarrier, isIDEDnDDropTarget, isValid, removeNotify, setContainerInterfaceSupportInfo, setErrorHandler, setIDEDnDDropBarrier, setIDEDnDDropTarget, setInsets, setInsets, setValidator, superAddNotify, superGetInsets, superRemoveNotify, superSetDefaultValues

Methods inherited from class com.sas.awt.PanelVisualComponent

addLink, addPropertyChangeListener, addVetoableChangeListener, anyPropertyChangeListeners, attachView, detachView, dumpComponent, firePropertyChange, firePropertyChange, fireVetoableChange, getBackgroundColor, getBorder, getComponentDescription, getComponentSupportInfo, getEventMethod, getEventValues, getFont, getForegroundColor, getHeight, getHorizontalPosition, getLinkInfo, getModelInterface, getPageBounds, getPreferredSize, getPrePainter, getPrintOptionsPanel, getVerticalPosition, getViewInterfaceSupportInfo, getVisualInterfaceSupportInfo, getWidth, initializeComponent, isDesignTime, isEnabled, isFocus, isLinked, isTransparent, isVisible, pageExists, paint, print, printFinalize, printInitialize, propertyChange, queryLinks, queryLinks, removeAllLinks, removeInterfaceTraps, removeLink, removePropertyChangeListener, removeVetoableChangeListener, setBorder, setComponentDescription, setComponentSupportInfo, setFocus, setHeight, setHorizontalPosition, setLinkInfo, setModelInterface, setPreferredSize, setPrePainter, setRequiredInterfaces, setTransparent, setVerticalPosition, setViewInterfaceSupportInfo, setVisible, setVisualInterfaceSupportInfo, setWidth, superGetFont, superGetMinimumSize, superGetPreferredSize, superIsEnabled, superIsVisible, superPaint, superSetBounds, superSetEnabled, superSetFont, superSetVisible, superUpdate, supportsListenerInterface, supportsRequiredInterfaces, trapInterfaceEvents, update, validateObject

Methods inherited from interface com.sas.awt.ContainerInterface

getComponents, getLayout, invalidate, setLayout, validate

Methods inherited from interface com.sas.awt.VisualInterface

getBackgroundColor, getBorder, getFont, getForegroundColor, getHeight, getHorizontalPosition, getPreferredSize, getPrePainter, getVerticalPosition, getVisualInterfaceSupportInfo, getWidth, isEnabled, isFocus, isTransparent, isVisible, setBorder, setFocus, setHeight, setHorizontalPosition, setPreferredSize, setPrePainter, setTransparent, setVerticalPosition, setVisible, setVisualInterfaceSupportInfo, setWidth, superGetFont, superGetMinimumSize, superGetPreferredSize, superIsEnabled, superIsVisible, superPaint, superSetBounds, superSetEnabled, superSetFont, superSetVisible, superUpdate

Field Summary
`static int`	`DROPDOWN`
`static int`	`DROPDOWNLIST`
`com.sas.collection.OrderedListCollection`	`excludedKeys`
`protected com.sas.visuals.ComboBoxFocusHandler`	`focusHandler`
`java.awt.event.ItemListener`	`itemListener`
`java.awt.event.KeyListener`	`keyListener`
`int`	`oldSelectedIndex`
`static java.lang.String`	`RB_KEY`
`static int`	`SIMPLE`
`boolean`	`textOverride`

Constructor Summary
`ComboBox()` Default constructor

Method Summary
`void`	`add(com.sas.Component comp)` Adds the specified component to this container.
`void`	`add(com.sas.Component comp, int index)` Adds the specified component to this container at the specified index.
`void`	`add(com.sas.Component comp, java.lang.Object constraints)` Adds the specified component to this container with the specified constraints.
`void`	`add(com.sas.Component comp, java.lang.Object constraints, int index)` Adds the specified component to this container with the specified constraints at the specified index.
`void`	`add(java.util.Enumeration items)` Adds items to the end of the list if the attached model supports addition of items.
`void`	`add(java.lang.Object[] items)` Adds items to the end of the list if the attached model supports addition of items.
`void`	`add(java.lang.String name, com.sas.Component comp)` Adds the specified component to this container.
`void`	`addImpl(com.sas.Component comp, java.lang.Object constraints, int index)` Adds the specified component to this container with the specified constraints at the specified index.
`void`	`addItem(java.lang.Object item)` Adds an item to the end of the list if the attached model supports addition of items.
`void`	`addItem(java.lang.Object item, int index)` Adds an item at the specified location if the attached model supports addition of items.
`void`	`addItemListener(java.awt.event.ItemListener l)` Add a listener to receive item events when the state of an item changes.
`void`	`addKeyListener(java.awt.event.KeyListener l)` Add a listener to receive key events
`void`	`addNotify()` Notifies the component that it has been added to a container and that the peer should be created.
`void`	`attachModel(com.sas.ModelInterface model)` Attaches a model to the component.
`protected int`	`calculateWindowHeight()` Calculates the height of the window in which to display the dropdown items
`java.awt.Dimension`	`computePreferredSize()` Returns the preferred size of the ComboBox
`void`	`contentsChanged(com.sas.collection.ContentsChangedEvent evt)` Called when the contents of the Model have changed.
`protected void`	`createItemEvent(int changed, java.lang.String selItem, int selected)` Processes item events by dispatching them to any registered ItemListener objects.
`protected void`	`createKeyEvent(int id, long when, int modifiers, int keyCode, char keyChar)` Processes key events by dispatching them to any registered KeyListener objects.
`void`	`detachModel(com.sas.ModelInterface model)` Detaches the current model and attaches the default model if the model is set to null
`void`	`displayList()` Displays the list portion of the comboBox
`static int`	`getDefaultHeight()` Returns the default height for instances of this class
`static int`	`getDefaultWidth()` Returns the default width for instances of this class
`com.sas.util.transforms.TransformInterface`	`getDisplayTransform()` Returns the display transform.
`static com.sas.beans.ExtendedBeanInfo`	`getExtendedBeanInfo()` Returns the ExtendedBeanInfo for this class.
`java.lang.String[]`	`getInitialItems()` Returns the initial items (an empty string array is returned if there are no initial items)
`com.sas.util.transforms.TransformInterface`	`getInputTransform()` Returns the input transform.
`java.awt.Dimension`	`getMinimumSize()` Returns the minimum size of the comboBox
`com.sas.util.transforms.TransformInterface`	`getOutputTransform()` Returns the output transform.
`java.util.Vector`	`getRequiredInterfaces()` Returns the required interfaces Vector for this component.
`int`	`getSelectedIndex()` Returns the selected index
`java.lang.String`	`getSelectedItem()` Returns the selectedItem
`java.lang.Object[]`	`getSelectedObjects()` Returns the selected object.
`int`	`getStyle()` Returns the style of the comboBox
`java.lang.String`	`getText()` Returns the text
`void`	`hideList()` Hide the list portion of the comboBox
`void`	`initialize()` Draw comboBox according to style chosen
`boolean`	`isAddTextToList()` Returns the value of the addTextToList property.
`boolean`	`isAutoHighlight()` Returns the value of the autoHighlight property
`boolean`	`isDefaultModelAttached()` Returns whether the default model is attached.
`boolean`	`isMatchedEntry()` Returns the value of the matchedEntry property.
`boolean`	`isResizeToFit()` Returns the value of the resizeToFit property.
`protected com.sas.visuals.ComboButton`	`newComboButton()`
`void`	`refresh()` Clears current items and add items obtained from the attached model
`void`	`refresh(com.sas.ModelInterface model)` Clear current items and add items obtained from the attached model
`void`	`remove(com.sas.Component comp)` Removes the specified component from this container.
`void`	`remove(int index)` Removes the component at the specified index from this container.
`void`	`removeAll()` Removes all the components from this container.
`void`	`removeAllItems()` Removes all items
`void`	`removeItem(int index)` Removes the item at the specified position if the attached model supports removal of items.
`void`	`removeItem(java.lang.Object item)` Removes the first occurrence of item if the attached model supports removal of items.
`void`	`removeItem(java.lang.String item)` Removes the first occurrence of item if the attached model supports removal of items.
`void`	`removeItemListener(java.awt.event.ItemListener l)` Removes an item listener.
`void`	`removeKeyListener(java.awt.event.KeyListener l)` Removes a key listener.
`void`	`replaceItem(java.lang.Object newvalue, int index)` Replaces an item if the attached model supports replacement of items.
`void`	`requestFocus()` Overridden in order to select the text in the textField if the autoHighlight property is true and the style is not DROPDOWNLIST
`void`	`selectedItem(java.lang.Object text)` Set the selected item to the specified object.
`void`	`setAddTextToList(boolean state)` Sets the specified boolean to indicate whether text entries should be added to the list.
`void`	`setAutoHighlight(boolean value)` Sets the specified boolean to indicate whether or not all text in the component will be selected when the component receives focus.
`void`	`setBackgroundColor(java.awt.Color color)` Sets the background color
`void`	`setBounds(int x, int y, int width, int height)` Reshapes the Component to the specified bounding box.
`static void`	`setDefaultHeight(int newDefaultHeight)` Sets the default height of the component.
`void`	`setDefaultValues()` Sets the initial values to the default values.
`static void`	`setDefaultWidth(int newDefaultWidth)` Sets the default width of the component.
`void`	`setDisplayTransform(com.sas.util.transforms.TransformInterface transform)` Sets the display transform.
`void`	`setEnabled(boolean value)` Sets the enabled property
`void`	`setFont(java.awt.Font font)` Sets the font
`void`	`setForeground(java.awt.Color color)` Sets the foreground color
`void`	`setForegroundColor(java.awt.Color color)` Sets the foreground color
`void`	`setInitialItems(java.lang.String[] items)` Sets the initial items
`void`	`setInputTransform(com.sas.util.transforms.TransformInterface transform)` Sets the input Transform.
`void`	`setMatchedEntry(boolean state)` Sets the value of the matchedEntry property.
`void`	`setOutputTransform(com.sas.util.transforms.TransformInterface transform)` Sets the output Transform.
`void`	`setResizeToFit(boolean value)` Sets the value of the resizeToFit property The resizeToFit property determines whether to change the size of the component when either the text or font changes.
`void`	`setSelectedIndex(int index)` Sets the selected index
`void`	`setSelectedItem(java.lang.String text)` Sets the selected item
`void`	`setStyle(int cstyle)` Sets the style of the comboBox
`void`	`setText(java.lang.String text)` Sets the text to the specified text

Methods inherited from class com.sas.awt.Panel
`remove`

Methods inherited from class com.sas.awt.PanelContainerComponent
`clone, dragEnter, dragLeave, dragOver, drop, getContainerInterfaceSupportInfo, getErrorHandler, getInsets, getValidator, isIDEDnDDropBarrier, isIDEDnDDropTarget, isValid, removeNotify, setContainerInterfaceSupportInfo, setErrorHandler, setIDEDnDDropBarrier, setIDEDnDDropTarget, setInsets, setInsets, setValidator, superAddNotify, superGetInsets, superRemoveNotify, superSetDefaultValues`

Methods inherited from class com.sas.awt.PanelVisualComponent
addLink, addPropertyChangeListener, addVetoableChangeListener, anyPropertyChangeListeners, attachView, detachView, dumpComponent, firePropertyChange, firePropertyChange, fireVetoableChange, getBackgroundColor, getBorder, getComponentDescription, getComponentSupportInfo, getEventMethod, getEventValues, getFont, getForegroundColor, getHeight, getHorizontalPosition, getLinkInfo, getModelInterface, getPageBounds, getPreferredSize, getPrePainter, getPrintOptionsPanel, getVerticalPosition, getViewInterfaceSupportInfo, getVisualInterfaceSupportInfo, getWidth, initializeComponent, isDesignTime, isEnabled, isFocus, isLinked, isTransparent, isVisible, pageExists, paint, print, printFinalize, printInitialize, propertyChange, queryLinks, queryLinks, removeAllLinks, removeInterfaceTraps, removeLink, removePropertyChangeListener, removeVetoableChangeListener, setBorder, setComponentDescription, setComponentSupportInfo, setFocus, setHeight, setHorizontalPosition, setLinkInfo, setModelInterface, setPreferredSize, setPrePainter, setRequiredInterfaces, setTransparent, setVerticalPosition, setViewInterfaceSupportInfo, setVisible, setVisualInterfaceSupportInfo, setWidth, superGetFont, superGetMinimumSize, superGetPreferredSize, superIsEnabled, superIsVisible, superPaint, superSetBounds, superSetEnabled, superSetFont, superSetVisible, superUpdate, supportsListenerInterface, supportsRequiredInterfaces, trapInterfaceEvents, update, validateObject

Methods inherited from interface com.sas.awt.ContainerInterface
`getComponents, getLayout, invalidate, setLayout, validate`

Methods inherited from interface com.sas.awt.VisualInterface
getBackgroundColor, getBorder, getFont, getForegroundColor, getHeight, getHorizontalPosition, getPreferredSize, getPrePainter, getVerticalPosition, getVisualInterfaceSupportInfo, getWidth, isEnabled, isFocus, isTransparent, isVisible, setBorder, setFocus, setHeight, setHorizontalPosition, setPreferredSize, setPrePainter, setTransparent, setVerticalPosition, setVisible, setVisualInterfaceSupportInfo, setWidth, superGetFont, superGetMinimumSize, superGetPreferredSize, superIsEnabled, superIsVisible, superPaint, superSetBounds, superSetEnabled, superSetFont, superSetVisible, superUpdate

Field Detail

textOverride

public boolean textOverride

oldSelectedIndex

public transient int oldSelectedIndex

itemListener

public transient java.awt.event.ItemListener itemListener

keyListener

public transient java.awt.event.KeyListener keyListener

excludedKeys

public transient com.sas.collection.OrderedListCollection excludedKeys

focusHandler

protected com.sas.visuals.ComboBoxFocusHandler focusHandler

RB_KEY

public static final java.lang.String RB_KEY

See Also:: Constant Field Values

DROPDOWN

public static final int DROPDOWN

See Also:: Constant Field Values

SIMPLE

public static final int SIMPLE

See Also:: Constant Field Values

DROPDOWNLIST

public static final int DROPDOWNLIST

See Also:: Constant Field Values

Constructor Detail

ComboBox

public ComboBox()

Default constructor

Method Detail

getDefaultWidth

public static int getDefaultWidth()

Returns the default width for instances of this class

Returns:: the default width in pixels
See Also:: setDefaultWidth(int)

setDefaultWidth

public static void setDefaultWidth(int newDefaultWidth)

Sets the default width of the component. The default width will be used by webAF when creating this component.

Parameters:: newDefaultWidth - the new default width in pixels
See Also:: getDefaultWidth()

getDefaultHeight

public static int getDefaultHeight()

Returns the default height for instances of this class

Returns:: the default height in pixels
See Also:: setDefaultHeight(int)

setDefaultHeight

public static void setDefaultHeight(int newDefaultHeight)

Sets the default height of the component. The default height will be used by webAF when creating this component.

Parameters:: newDefaultHeight - the new default height in pixels
See Also:: getDefaultHeight()

getExtendedBeanInfo

public static com.sas.beans.ExtendedBeanInfo getExtendedBeanInfo()

Returns the ExtendedBeanInfo for this class.

Returns:: ExtendedBeanInfo for this class

add

public void add(com.sas.Component comp)

Adds the specified component to this container.

Parameters:: comp - component to be added

add

public void add(java.lang.String name,
                com.sas.Component comp)

Adds the specified component to this container.

Parameters:: name - component name; comp - component to be added

add

public void add(com.sas.Component comp,
                int index)

Adds the specified component to this container at the specified index.

Parameters:: comp - component to be added; index - the position in the container's list at which to insert the component. -1 means insert at the end.

add

public void add(com.sas.Component comp,
                java.lang.Object constraints)

Adds the specified component to this container with the specified constraints.

Parameters:: comp - component to be added; constraints - layout contraints for this component

add

public void add(com.sas.Component comp,
                java.lang.Object constraints,
                int index)

Adds the specified component to this container with the specified constraints at the specified index.

Parameters:: comp - component to be added; constraints - layout contraints for this component; index - the position in the container's list at which to insert the component. -1 means insert at the end.

addImpl

public void addImpl(com.sas.Component comp,
                    java.lang.Object constraints,
                    int index)

Adds the specified component to this container with the specified constraints at the specified index.

Parameters:: comp - component to be added; constraints - layout contraints for this component; index - the position in the container's list at which to insert the component. -1 means insert at the end.

addItem

public void addItem(java.lang.Object item)

Adds an item to the end of the list if the attached model supports addition of items.

Parameters:: item - item to be added

addItem

public void addItem(java.lang.Object item,
                    int index)

Adds an item at the specified location if the attached model supports addition of items.

Parameters:: item - item to be added; index - location for adding the item

add

public void add(java.lang.Object[] items)

Adds items to the end of the list if the attached model supports addition of items.

Parameters:: items - items to be added

add

public void add(java.util.Enumeration items)

Adds items to the end of the list if the attached model supports addition of items.

Parameters:: items - items to be added

addItemListener

public void addItemListener(java.awt.event.ItemListener l)

Add a listener to receive item events when the state of an item changes.

Specified by:: addItemListener in interface java.awt.ItemSelectable

Parameters:: l - the listener to receive events.

addKeyListener

public void addKeyListener(java.awt.event.KeyListener l)

Add a listener to receive key events

Overrides:: addKeyListener in class java.awt.Component

Parameters:: l - the listener to receive events.

addNotify

public void addNotify()

Notifies the component that it has been added to a container and that the peer should be created.

Specified by:: addNotify in interface ContainerInterface
Overrides:: addNotify in class PanelContainerComponent

attachModel

public void attachModel(com.sas.ModelInterface model)

Attaches a model to the component.

Specified by:: attachModel in interface com.sas.ViewInterface
Overrides:: attachModel in class PanelVisualComponent

Parameters:: model - model to attach
See Also:: ViewInterface.attachModel(com.sas.ModelInterface)

calculateWindowHeight

protected int calculateWindowHeight()

Calculates the height of the window in which to display the dropdown items

Returns:: calculated window height

computePreferredSize

public java.awt.Dimension computePreferredSize()

Returns the preferred size of the ComboBox

Specified by:: computePreferredSize in interface VisualInterface
Overrides:: computePreferredSize in class PanelVisualComponent

Returns:: preferred size of the ComboBox
See Also:: VisualInterface.computePreferredSize()

contentsChanged

public void contentsChanged(com.sas.collection.ContentsChangedEvent evt)

Called when the contents of the Model have changed.

Specified by:: contentsChanged in interface com.sas.collection.ContentsChangedListener

Parameters:: evt - ContentsChangedEvent from the Model

createItemEvent

protected void createItemEvent(int changed,
                               java.lang.String selItem,
                               int selected)

Processes item events by dispatching them to any registered ItemListener objects.

Parameters:: e - the item event

createKeyEvent

protected void createKeyEvent(int id,
                              long when,
                              int modifiers,
                              int keyCode,
                              char keyChar)

Processes key events by dispatching them to any registered KeyListener objects.

Parameters:: e - the key event

detachModel

public void detachModel(com.sas.ModelInterface model)

Detaches the current model and attaches the default model if the model is set to null

Specified by:: detachModel in interface com.sas.ViewInterface
Overrides:: detachModel in class PanelVisualComponent

Parameters:: model - Model to detach
See Also:: ViewInterface.detachModel(com.sas.ModelInterface)

displayList

public void displayList()

Displays the list portion of the comboBox

getDisplayTransform

public com.sas.util.transforms.TransformInterface getDisplayTransform()

Returns the display transform.

Returns:: the display transform
See Also:: setDisplayTransform(com.sas.util.transforms.TransformInterface)

getInitialItems

public java.lang.String[] getInitialItems()

Returns the initial items (an empty string array is returned if there are no initial items)

Returns:: initial items
See Also:: setInitialItems(java.lang.String[])

getInputTransform

public com.sas.util.transforms.TransformInterface getInputTransform()

Returns the input transform.

Returns:: the input transform
See Also:: setInputTransform(com.sas.util.transforms.TransformInterface)

getMinimumSize

public java.awt.Dimension getMinimumSize()

Returns the minimum size of the comboBox

Specified by:: getMinimumSize in interface VisualInterface
Overrides:: getMinimumSize in class PanelVisualComponent

Returns:: minimum size of the comboBox
See Also:: VisualInterface.getMinimumSize()

getOutputTransform

public com.sas.util.transforms.TransformInterface getOutputTransform()

Returns the output transform.

Returns:: the output transform
See Also:: setOutputTransform(com.sas.util.transforms.TransformInterface)

getRequiredInterfaces

public java.util.Vector getRequiredInterfaces()

Returns the required interfaces Vector for this component.

Specified by:: getRequiredInterfaces in interface com.sas.ViewInterface
Overrides:: getRequiredInterfaces in class PanelVisualComponent

Returns:: the required interfaces Vector for this component.
See Also:: ViewInterface.getRequiredInterfaces()

getSelectedIndex

public int getSelectedIndex()

Returns the selected index

Returns:: selected index
See Also:: setSelectedIndex(int)

getSelectedItem

public java.lang.String getSelectedItem()

Returns the selectedItem

Returns:: selectedItem
See Also:: setSelectedItem(java.lang.String)

getSelectedObjects

public java.lang.Object[] getSelectedObjects()

Returns the selected object. This method is overriden in order to actually contain an object within the object array(AWT returns an object array containing a string item). An empty object array is returned if there are no selectedObjects)

Specified by:: getSelectedObjects in interface java.awt.ItemSelectable

Returns:: object array that contains the object selected

getStyle

public int getStyle()

Returns the style of the comboBox

Returns:: comboBox style
See Also:: setStyle(int)

getText

public java.lang.String getText()

Returns the text

Specified by:: getText in interface com.sas.lang.StringDataInterface

Returns:: text
See Also:: setText(java.lang.String)

hideList

public void hideList()

Hide the list portion of the comboBox

initialize

public void initialize()

Draw comboBox according to style chosen

Specified by:: initialize in interface com.sas.ComponentInterface
Overrides:: initialize in class PanelVisualComponent

See Also:: ComponentInterface.initialize()

isAddTextToList

public boolean isAddTextToList()

Returns the value of the addTextToList property. The addTextToList property indicates whether text entries should be added to the list.

Returns:: value of the addTextToList property
See Also:: setAddTextToList(boolean)

isAutoHighlight

public boolean isAutoHighlight()

Returns the value of the autoHighlight property

Returns:: value of the autoHighlight property
See Also:: setAutoHighlight(boolean)

isDefaultModelAttached

public boolean isDefaultModelAttached()

Returns whether the default model is attached.

Specified by:: isDefaultModelAttached in interface com.sas.ViewDefaultModelInterface

Returns:: whether the default model is attached.

isMatchedEntry

public boolean isMatchedEntry()

Returns the value of the matchedEntry property. The matchedEntry property indicates whether a character that is typed in the text control should be used to match entries in the list portion of the comboBox

Returns:: state boolean value
See Also:: setMatchedEntry(boolean)

isResizeToFit

public boolean isResizeToFit()

Returns the value of the resizeToFit property. The resizeToFit property determines whether to change the size of the component when either the text or font changes.

Specified by:: isResizeToFit in interface ResizeToFitInterface

Returns:: value of the resizeToFit property
See Also:: setResizeToFit(boolean)

newComboButton

protected com.sas.visuals.ComboButton newComboButton()

refresh

public void refresh()

Clears current items and add items obtained from the attached model

refresh

public void refresh(com.sas.ModelInterface model)

Clear current items and add items obtained from the attached model

Specified by:: refresh in interface com.sas.ViewInterface
Overrides:: refresh in class PanelVisualComponent

Parameters:: model - attached model
See Also:: ViewInterface.refresh(com.sas.ModelInterface)

remove

public void remove(com.sas.Component comp)

Removes the specified component from this container.

Parameters:: comp - component to be removed

remove

public void remove(int index)

Removes the component at the specified index from this container.

Overrides:: remove in class Panel

Parameters:: index - index of the component to be removed

removeAll

public void removeAll()

Removes all the components from this container.

Overrides:: removeAll in class Panel

removeAllItems

public void removeAllItems()

Removes all items

removeItem

public void removeItem(java.lang.String item)

Removes the first occurrence of item if the attached model supports removal of items.

Parameters:: item - item to be removed

removeItem

public void removeItem(java.lang.Object item)
                throws com.sas.util.transforms.TransformException

Removes the first occurrence of item if the attached model supports removal of items.

Parameters:: item - item to be removed
Throws:: com.sas.util.transforms.TransformException - if there is an error in transformin the item.

removeItem

public void removeItem(int index)

Removes the item at the specified position if the attached model supports removal of items.

Parameters:: index - index of the item to be removed

removeItemListener

public void removeItemListener(java.awt.event.ItemListener l)

Removes an item listener.

Specified by:: removeItemListener in interface java.awt.ItemSelectable

Parameters:: l - the item listener to remove

removeKeyListener

public void removeKeyListener(java.awt.event.KeyListener l)

Removes a key listener.

Overrides:: removeKeyListener in class java.awt.Component

Parameters:: l - the key listener to remove

requestFocus

public void requestFocus()

Overridden in order to select the text in the textField if the autoHighlight property is true and the style is not DROPDOWNLIST

Overrides:: requestFocus in class java.awt.Component

replaceItem

public void replaceItem(java.lang.Object newvalue,
                        int index)
                 throws com.sas.util.transforms.TransformException

Replaces an item if the attached model supports replacement of items.

Parameters:: newvalue - replacement text; index - index of the item to be replaced
Throws:: com.sas.util.transforms.TransformException

setAddTextToList

public void setAddTextToList(boolean state)

Sets the specified boolean to indicate whether text entries should be added to the list. This property applies to Dropdown and Simple style comboBox only. Setting addTextToList to true for Dropdownlist style will have no effect.

Parameters:: state - boolean value

setAutoHighlight

public void setAutoHighlight(boolean value)

Sets the specified boolean to indicate whether or not all text in the component will be selected when the component receives focus. If set to true, all text will be selected when the component receives focus and deselected when the component loses focus

Parameters:: value - boolean value

setBackgroundColor

public void setBackgroundColor(java.awt.Color color)

Sets the background color

Specified by:: setBackgroundColor in interface VisualInterface
Overrides:: setBackgroundColor in class PanelVisualComponent

Parameters:: color - color
See Also:: VisualInterface.setBackgroundColor(java.awt.Color)

setBounds

public void setBounds(int x,
                      int y,
                      int width,
                      int height)

Reshapes the Component to the specified bounding box.

Specified by:: setBounds in interface VisualInterface
Overrides:: setBounds in class PanelVisualComponent

Parameters:: x - x coordinate; y - y coordinate; width - width of the component; height - height of the component
See Also:: VisualInterface.setBounds(int, int, int, int)

setDisplayTransform

public void setDisplayTransform(com.sas.util.transforms.TransformInterface transform)

Sets the display transform. The display transform is used to transform the data prior to it being displayed.

Parameters:: transform - the new value for the displayTransform property
See Also:: getDisplayTransform()

setEnabled

public void setEnabled(boolean value)

Sets the enabled property

Specified by:: setEnabled in interface VisualInterface
Overrides:: setEnabled in class PanelVisualComponent

Parameters:: value - boolean indicating whether to enable/disable component
See Also:: VisualInterface.setEnabled(boolean)

setFont

public void setFont(java.awt.Font font)

Sets the font

Specified by:: setFont in interface VisualInterface
Overrides:: setFont in class PanelVisualComponent

Parameters:: font - font
See Also:: Component.setFont(java.awt.Font)

setForegroundColor

public void setForegroundColor(java.awt.Color color)

Sets the foreground color

Specified by:: setForegroundColor in interface VisualInterface
Overrides:: setForegroundColor in class PanelVisualComponent

Parameters:: color - color
See Also:: Component.setForeground(java.awt.Color)

setForeground

public void setForeground(java.awt.Color color)

Sets the foreground color

Overrides:: setForeground in class java.awt.Component

Parameters:: color - color
See Also:: Component.setForeground(java.awt.Color)

setInputTransform

public void setInputTransform(com.sas.util.transforms.TransformInterface transform)

Sets the input Transform. The inputTransform is used to transform the input to methods of the CombotBox to the objects that are in the model.

Parameters:: the - new value for the inputTransform property
See Also:: getInputTransform()

setOutputTransform

public void setOutputTransform(com.sas.util.transforms.TransformInterface transform)

Sets the output Transform. The outputTransform is used to transform the output from methods of the ComboBox from the objects that are in the model.

Parameters:: transform - the new value for the outputTransform property
See Also:: getOutputTransform()

setDefaultValues

public void setDefaultValues()

Sets the initial values to the default values. This method is called by the Component constructors. The exception method of each class is responsible for setting its own initial values.

Specified by:: setDefaultValues in interface ContainerInterface
Specified by:: setDefaultValues in interface VisualInterface
Specified by:: setDefaultValues in interface com.sas.ComponentInterface
Overrides:: setDefaultValues in class CompositePanel

See Also:: ContainerInterface.setDefaultValues()

setInitialItems

public void setInitialItems(java.lang.String[] items)

Sets the initial items

Parameters:: items - an array of elements

setMatchedEntry

public void setMatchedEntry(boolean state)

Sets the value of the matchedEntry property. The matchedEntry property indicates whether a character that is typed in the text control should be used to match entries in the list portion of the comboBox. Setting the matchedEntry property to true is honored only if the addTextToList property is false

Parameters:: state - boolean value
See Also:: isMatchedEntry()

setResizeToFit

public void setResizeToFit(boolean value)

Sets the value of the resizeToFit property The resizeToFit property determines whether to change the size of the component when either the text or font changes. If the component is managed by a layout manager that uses preferred sizes, the component will behave as if the resizeToFit property has been set to true regardless of the actual value. of the resizeToFit property.

Specified by:: setResizeToFit in interface ResizeToFitInterface

Parameters:: value - boolean value
See Also:: isResizeToFit()

setSelectedIndex

public void setSelectedIndex(int index)

Sets the selected index

Parameters:: index - index of the item to be selected
See Also:: getSelectedIndex()

selectedItem

public void selectedItem(java.lang.Object text)
                  throws com.sas.util.transforms.TransformException

Set the selected item to the specified object. If more than one item matches the specified object, the one with the smallest index is selected.

Parameters:: text - item to be selected
Throws:: com.sas.util.transforms.TransformException - if there is an error in transformin the item.

setSelectedItem

public void setSelectedItem(java.lang.String text)

Sets the selected item

Parameters:: text - item to be selected
See Also:: getSelectedItem()

setStyle

public void setStyle(int cstyle)

Sets the style of the comboBox

Parameters:: cstyle - comboBox style
See Also:: getStyle()

setText

public void setText(java.lang.String text)

Sets the text to the specified text

Specified by:: setText in interface com.sas.lang.StringDataInterface

Parameters:: text - text
See Also:: getText()

All Libraries

This Library

Package

Class

Use

Tree

Deprecated

Index

Grand Index

Help

Components

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.sas.visuals Class ComboBox

textOverride

oldSelectedIndex

itemListener

keyListener

excludedKeys

focusHandler

RB_KEY

DROPDOWN

SIMPLE

DROPDOWNLIST

ComboBox

getDefaultWidth

setDefaultWidth

getDefaultHeight

setDefaultHeight

getExtendedBeanInfo

add

add

add

add

add

addImpl

addItem

addItem

add

add

addItemListener

addKeyListener

addNotify

attachModel

calculateWindowHeight

computePreferredSize

contentsChanged

createItemEvent

createKeyEvent

detachModel

displayList

getDisplayTransform

getInitialItems

getInputTransform

getMinimumSize

getOutputTransform

getRequiredInterfaces

getSelectedIndex

getSelectedItem

getSelectedObjects

getStyle

getText

hideList

initialize

isAddTextToList

isAutoHighlight

isDefaultModelAttached

isMatchedEntry

isResizeToFit

newComboButton

refresh

refresh

remove

remove

removeAll

removeAllItems

removeItem

removeItem

removeItem

removeItemListener

removeKeyListener

requestFocus

replaceItem

setAddTextToList

setAutoHighlight

setBackgroundColor

setBounds

setDisplayTransform

setEnabled

setFont

setForegroundColor

setForeground

setInputTransform

com.sas.visuals
Class ComboBox