Parts Reference


Packeting Container Details properties

The Packeting Container Details part has the following properties:

attributeName
The attributeName property represents the name of the property within the collection of items to be displayed in the part.

autoTab
The autoTab property indicates whether tabbing should automatically occur when the textLimit is reached.

backgroundColor
The backgroundColor property is the name of the RGB color for the background of the part.

borderWidth
The borderWidth property is the width of the border, specified in pixels, that surrounds the part on all four sides. A width of zero means that a border does not show.

On some platforms, the border width is limited to 1 pixel and any nonzero value is set to 1.

cellTabbingPolicy
The cellTabbingPolicy property specifies how tabbing within cells should behave. This property is used only when the selectionPolicy is set to XmCELLSINGLESELECT. Possible values are:

XmACROSSROWS
When the last cell in a row is reached while tabbing forward, go to the first cell in the next row. When the first cell in a row is reached while tabbing backward, go to the last cell in the previous row.

XmWITHINROW
When the last cell in a row is reached while tabbing forward, go to the first cell in the same row. When the first cell in a row is reached while tabbing backward, go to the last cell in the same row.

XmAPPLICATIONDEFINED
Tabbing behavior is defined by the application. To use this option, the application must hook #applicationDefinedTabbingRequested.

columnSelectionIndex
The columnSelectionIndex property indicates which column, if any, is initially selected.

dragDropSpec (AbtDragDropSpec)
The dragDropSpec property specifies the drag and drop information for the part.

You can tear-off the dragDropSpec property to access its properties and events. If the part has a Drag/Drop tab in its Settings window, the drag and drop properties and events will be added to the part once you have selected either Allow drag or Allow drop in the part's Settings window.

The dragDropSpec property has the following properties for specifying drag and drop information:

canBeDragSource (Boolean)
Specifies whether the part can be the source of a drag operation. The source is where the drag is started.

canBeDragTarget (Boolean)
Specifies whether the part can be the target of a drag operation. The target is the part under the cursor during the drag.

defaultDragOperations (OrderedCollection)
Specifies the following default drag operations for the array of any or all elements, with the first elements having the highest priority:
  • XmMOVE
  • XmCOPY
  • XmLINK
  • XmILLEGAL

defaultDropOperations (OrderedCollection)
Specifies the following default drop operations for the array of any or all elements, with the first elements having the highest priority:
  • XmMOVE
  • XmCOPY
  • XmLINK
  • XmILLEGAL

dropAcceptableClassList (OrderedCollection)
Specifies a list of classes where instances can be added to the part for a drop operation.

The dragDropSpec property has the following drag and drop events, which all pass a callData parameter from which it gets information about the source, target, operation, and emphasis:

dragChanged
Signals to the source that the target or operation of the drag session has changed.

dragCompleteRequested
Signals to the source that the drag session has completed and requests that the source perform any necessary actions for the operation.

dragLeave
Signals to the target that the mouse pointer has left its bounding box during a drag session. You may want to use this for changing the target emphasis.

dragOver
Signals to the target that the mouse pointer is moving over it during a drag session. The target must fill in the vote field of the callData parameter with the operation acceptable with regard to the source items. See the defaultDropOperations attribute for acceptable vote values.

dragSourceCancelled
Signals to the source that the drag operation was cancelled.

dragStartRequested
Signals to the source that the drag session has started. The source items, images and offsets must be filled in the respective fields of the callData parameter.

dragTargetCancelled
Signals to the target that the drag operation was cancelled.

dropped
Signals to the target that the dragged items have been dropped and requests that the target perform any actions necessary for the drop operation.

editable
The editable property specifies whether the text in the part can be edited.
Note:For the Container Details parts, this attribute along with the columns attribute determine whether the column cells are editable. However, the various edit events (such as editCellAt: or editSelectedCell) will edit the column, regardless of the values of these attributes.

enabled
The enabled property specifies whether or not the part is available for selection. If true, the part's contents are available for selection.

fontName
The fontName property is the name of the font to use for the text displayed in the part.

foregroundColor
The foregroundColor property is the name of the RGB color for the foreground of the part.

framingSpec
The framingSpec property represents the values specified for the edge specifications of the part. The edge specifications determine the width, height, and position of the part.

headingBackgroundColor
The headingBackgroundColor property specifies the background color for the heading of the container.

headingFontName
The headingFontName property specifies the name of the font you want to use for the heading of the part.

headingSeparatorThickness
The headingSeparatorThickness property specifies the width of the horizontal line separating the column headings from the rest of the container. The default value is 1.

headingVisualStyle
The headingVisualStyle property specifies how the cells of the part are displayed. Possible values include the following:

XmFLAT
Displays the cells like a list box.

XmETCHROWS
Displays each row as etched. This is the default value.

XmETCHCELLS
Displays each cell in an etched column as individually etched.

helpFile
The helpFile property is the name of the help file associated with the part.

helpKeysId
The helpKeysId property is the ID of the keys help associated with the part. The ID can be a string or an integer value.

The ID must exist in the help file associated with the part.

helpTitle
The helpTitle property is the title of the help window associated with the part.

helpTopicId
The helpTopicId property is the ID of the help topic associated with the part. The ID can be a string or an integer value.

The ID must exist in the help file associated with the part.

itemHeight
The itemHeight property specifies the height to use for each icon and label in the part.

lockedColumns
The lockedColumns property specifies the number of columns from the left edge of the container that remain fixed and cannot be scrolled horizontally.

partName
The partName property specifies the name you want to use to describe the part. For nonvisual parts, this text appears under the icon for the part on the free-form surface.

The name of the part can consist of alphanumeric characters, and must be different from those of all other parts on the layout surface.

If you do not specify a part name, VisualAge generates a unique name based on the class name of the part.

refreshEntireListOnChange
The refreshEntireListOnChange property specifies whether or not the list of items is updated when a change is made to one of the items.

refreshItemOnAttributeChange
The refreshItemOnAttributeChange property indicates whether to update the container if an attribute of an item in the model changes.

resizableColumns
The resizableColumns property indicates whether the columns can be resized at run time.

rowSeparators
The rowSeparators property specifies whether you want separators between the rows of the container.

scrollBarDisplayPolicy
The scrollBarDisplayPolicy property controls the automatic placement of the scroll bars. Possible values are:

XmASNEEDED
Scroll bars will only be displayed if the list items exceed the container work region either horizontally or vertically.

XmSTATIC
Scroll bars will be displayed regardless of the relationship between the size of the list items and the container.

scrollingWithHiddenScrollBars
The scrollingWithHiddenScrollBars property specifies whether or not the scroll bars should be hidden. If true, the scroll bars are hidden, but scrolling can still be performed.

selectableColumns
The selectableColumns property specifies whether the columns in the container can be selected.

selectionPolicy
The selectionPolicy property specifies the selection policy in the container. The possible values, which depend upon the part, are as follows:

XmBROWSESELECT
Enables drag and browse functionality.

XmCELLSINGLESELECT
Only one cell in the container can be selected at a time.

XmEXTENDEDSELECT
Enables extended selection. This is the default value.

XmMULTIPLESELECT
Enables multiple selection.

XmREADONLYSELECT
Enables navigation, but no selection or callbacks.

XmSINGLESELECT
Only one row in the container can be selected at a time.

separatorsToExtremes
The separatorsToExtremes property determines whether the column and row separators extend to the edge of the container or just to the end of the last item.

showColumnHeadings
The showColumnHeadings property indicates whether the column headings should be visible.

showHorizontalScrollBar
The showHorizontalScrollBar property specifies whether or not to display a horizontal scroll bar so the user can scroll horizontally through the text. If true, a horizontal scroll bar is displayed.

statusLabelBackgroundColor
The statusLabelBackgroundColor property specifies the name of the RGB color for the background of the label in the status line.

statusLabelFontName
The statusLabelFontName property specifies the name of the font to use for the label in the status line.

statusLabelForegroundColor
The statusLabelForegroundColor property specifies the name of the RGB color for the foreground of the label in the status line.

statusLabelString
The statusLabelString property specifies the text of the label in the status line.

tabGroup
The tabGroup property specifies whether or not the part is included as a tab stop so users can use the Tab and Backtab keys to access the part.

traversalOn
The traversalOn property specifies whether users can access the part using the cursor movement keys. If the part is specified as a tab stop by using the tabGroup property, users also can use the Tab and Backtab keys to access the part.

visualStyle
The visualStyle property defines how the cells are displayed. Possible values are:

XmFLAT
Looks like a list box

XmETCHROWS
Has each row etched

XmETCHCELLS
Has each cell in an etched column individually etched.


[ Top of Page | Previous Page | Next Page | Table of Contents | Index ]