API Documentation > Classes > Class DetailSymbolGroups
Class DetailSymbolGroups

package com.ptc.pfc.pfcDetail;

public class DetailSymbolGroups
implements jxobject


Description
An ordered collection of objects of a certain type.
The user can access elements by their integer index (position) in the list. Sequence provides methods for positional (indexed) access to its elements. Sequences are zero based.
Method Summary
Creates a new empty sequence.
/*optional*/ DetailSymbolGroup
get (int idx)
Returns the value of the sequence element with the specified index. If the index is out of range, this method throws exceptioncipXInvalidSeqIndex.
int
Returns current number of elements in the sequence.
void
insert (int idx, /*optional*/ DetailSymbolGroup value)
Inserts an element with the specified value in front of the sequence element with the specified index. If the index is out of range, the sequence is expanded to include this index.
void
Inserts elements from the list passed as the second argument in front of the sequence element with the specified index. If the index is out of range, the sequence is expanded to include this index.
void
removerange (int frominc, int toexcl)
Removes elements in the specified range from the sequence. The first argument specifies the index of the first element to be removed. The second argument specifies the index of the element immediately after the last in the range to be removed.
void
set (int idx, /*optional*/ DetailSymbolGroup value)
Assigns a value to the sequence element with the specified index. If the index is out of range, the sequence is expanded to include this index.
Method Detail
getarraysize
int
getarraysize
()
Returns current number of elements in the sequence.
Returns:
Current number of elements.
get
/*optional*/ DetailSymbolGroup
get
(int idx)
Returns the value of the sequence element with the specified index. If the index is out of range, this method throws exception cipXInvalidSeqIndex.
Parameters:
idx
Index of requested sequence element.
Returns:
Value of the element at the specified index.
set
void
set
(int idx, /*optional*/ DetailSymbolGroup value)
Assigns a value to the sequence element with the specified index. If the index is out of range, the sequence is expanded to include this index.
Parameters:
idx
Index of the element to be assigned.
value
Value to be assigned.
Returns:
removerange
void
removerange
(int frominc, int toexcl)
Removes elements in the specified range from the sequence. The first argument specifies the index of the first element to be removed. The second argument specifies the index of the element immediately after the last in the range to be removed.
Parameters:
frominc
Index of the first element to be removed.
toexcl
Index of the element following the last element to be removed.
Returns:
insert
void
insert
(int idx, /*optional*/ DetailSymbolGroup value)
Inserts an element with the specified value in front of the sequence element with the specified index. If the index is out of range, the sequence is expanded to include this index.
Parameters:
idx
Index for an element to be inserted at.
value
Value to be inserted.
Returns:
insertseq
void
insertseq
(int idx, DetailSymbolGroups seq)
Inserts elements from the list passed as the second argument in front of the sequence element with the specified index. If the index is out of range, the sequence is expanded to include this index.
Parameters:
idx
Index at which the first new element should be inserted.
seq
Sequence of elements to be inserted.
Returns:
create
create
()
Creates a new empty sequence.
Returns:
Created sequence.
Was this helpful?