## org.autoplot.pngwalk.WalkImageSequence

This class maintains a list of `WalkImage`s and provides functionality for navigating through it. Whenever the current index is changed, whether explicitly set or via one of the navigation functions, a `PropertyChangeEvent` is fired. This allows UI code to control the index and view code to respond.

Access is also provided to the {@link WalkImage} objects so that view code can retrieve images, thumbnails, etc.

## WalkImageSequence( String template )

Create an image sequence based on a URI template.

## PROP_INDEX

## PROP_SELECTED_INDECES

## PROP_IMAGE_LOADED

## PROP_THUMB_LOADED

## PROP_USESUBRANGE

## PROP_SEQUENCE_CHANGED

## PROP_BADGE_CHANGE

## PROP_TIMERANGE

## PROP_STATUS

## addPropertyChangeListener

addPropertyChangeListener( java.beans.PropertyChangeListener l ) → void

things we fire events for: PROP_BADGE_CHANGE and others

### Parameters

l - a PropertyChangeListener

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]
addPropertyChangeListener( String propertyName, java.beans.PropertyChangeListener listener ) → void [view source]

## currentImage

currentImage( ) → org.autoplot.pngwalk.WalkImage

### Returns:

org.autoplot.pngwalk.WalkImage
[search for examples] [view on GitHub] [view on old javadoc]

## findIndex

findIndex( String name ) → int

returns the index of the name, or -1 if the name is not found. This is not the full filename, but instead just the part of the name within the walk. For example, For example if getTemplate is file:/tmp/$Y$m$d.gif, then the setSelectedName might be 20141111.gif.

### Parameters

name - the file name.

### Returns:

the index, or -1 if the name is not found.
[search for examples] [view on GitHub] [view on old javadoc]

## first

first( ) → void

Move the index to the first image in the list.

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]

## getActiveSubrange

getActiveSubrange( ) → java.util.List

return the active subrange of the sequence. This is the portion of the pngwalk being used.

### Returns:

the subrange of the sequence.

### See Also:

https://sourceforge.net/p/autoplot/feature-requests/493/
[search for examples] [view on GitHub] [view on old javadoc]

## getAllTimes

getAllTimes( ) → java.util.List

Return a `java.awt.List` of the times associated with this sequence. This list will include times associated with missing images, and is not restricted to any currently active subrange.

### Returns:

a java.util.List
[search for examples] [view on GitHub] [view on old javadoc]

## getBaseUri

getBaseUri( ) → java.net.URI

return the location of the PNGWalk, which should contain the image files.

### Returns:

a java.net.URI
[search for examples] [view on GitHub] [view on old javadoc]

## getImage

getImage( java.net.URI image ) → org.autoplot.pngwalk.WalkImage

return the WalkImage object for the given URI.

### Parameters

image - the location

### Returns:

the object modeling this image.
[search for examples] [view on GitHub] [view on old javadoc]

## getIndex

getIndex( ) → int

Return the current value of the index, where index is that of the displayImages.

### Returns:

an int
[search for examples] [view on GitHub] [view on old javadoc]

## getQCFilter

getQCFilter( ) → String

returns the current QC filter, where "" means no filter, otherwise the characters indicate:

- o okay are shown
- p problem are shown
- i ignore are shown

### Returns:

the filter, for example "" or "op" for okay and problem.
[search for examples] [view on GitHub] [view on old javadoc]

## getQCFolder

getQCFolder( ) → java.net.URI

### Returns:

java.net.URI
[search for examples] [view on GitHub] [view on old javadoc]

## getQualityControlSequence

getQualityControlSequence( ) → org.autoplot.pngwalk.QualityControlSequence

this may be null if even though we are using QualityControl, if the user hasn't logged in yet.

### Returns:

an org.autoplot.pngwalk.QualityControlSequence
[search for examples] [view on GitHub] [view on old javadoc]

## getSelectedIndeces

getSelectedIndeces( ) → java.util.List

### Returns:

java.util.List
[search for examples] [view on GitHub] [view on old javadoc]

## getSelectedName

getSelectedName( ) → String

return the name of the selected image. This is not the full filename, but instead just the part of the name within the walk. For example, For example if getTemplate is file:/tmp/$Y$m$d.gif, then the setSelectedName might be 20141111.gif.

### Returns:

the name of the selected image.
[search for examples] [view on GitHub] [view on old javadoc]

## getStatus

getStatus( ) → String

get the current status

### Returns:

a String
[search for examples] [view on GitHub] [view on old javadoc]

## getTemplate

getTemplate( ) → String

return the template representing the sequence.

### Returns:

the template
[search for examples] [view on GitHub] [view on old javadoc]

## getTimeSpan

getTimeSpan( ) → DatumRange

Return the time range covered by this sequence. This is the total range of available images, not any currently displayed subrange. Will be null if no date template was used to create the sequence.

### Returns:

the time range covered by this sequence.
[search for examples] [view on GitHub] [view on old javadoc]

## getTimerange

getTimerange( ) → DatumRange

constraint for the limit of the time ranges listed. Note timespan is what was found. This does not appear to be the current image timerange.

### Returns:

a DatumRange
[search for examples] [view on GitHub] [view on old javadoc]

## imageAt

imageAt( int n ) → org.autoplot.pngwalk.WalkImage

return the image of the subrange.

### Parameters

n - an int

### Returns:

an org.autoplot.pngwalk.WalkImage
[search for examples] [view on GitHub] [view on old javadoc]

## imageAtNoSubRange

imageAtNoSubRange( int n ) → org.autoplot.pngwalk.WalkImage

get the image in the sequence, regardless of the subrange.

### Parameters

n - an int

### Returns:

an org.autoplot.pngwalk.WalkImage
[search for examples] [view on GitHub] [view on old javadoc]

## initialLoad

initialLoad( ) → void

do the initial listing of the remote filesystem. This should not be done on the event thread, and should be done before the sequence is used.

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]

## isContainsGaps

isContainsGaps( ) → boolean

true if the sequence has been generated so that gaps could be shown.

### Returns:

true if the sequence has been generated so that gaps could be shown.
[search for examples] [view on GitHub] [view on old javadoc]

## isShowMissing

isShowMissing( ) → boolean

### Returns:

boolean
[search for examples] [view on GitHub] [view on old javadoc]

## isUseSubRange

isUseSubRange( ) → boolean

### Returns:

boolean
[search for examples] [view on GitHub] [view on old javadoc]

## last

last( ) → void

Move the image to the last image in the list.

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]

## next

next( ) → void

Advance the index to the next image in the list. If the index is already at the last image, do nothing.

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]

## prev

prev( ) → void

Step the index to the previous image in the list. If the index is already at the first image, do nothing.

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]

## propertyChange

propertyChange( java.beans.PropertyChangeEvent e ) → void

### Parameters

e - a PropertyChangeEvent

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]

## removePropertyChangeListener

removePropertyChangeListener( java.beans.PropertyChangeListener l ) → void

### Parameters

l - a PropertyChangeListener

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]
removePropertyChangeListener( String propertyName, java.beans.PropertyChangeListener listener ) → void [view source]

## setActiveSubrange

setActiveSubrange( int first, int last ) → void

Set the sequence's active subrange to a range from first to last, inclusive. First and last are indices into the list obtained from `getAllTimes()`.

### Parameters

first - an int
last - an int

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]

## setActiveSubrange

setActiveSubrange( DatumRange range ) → void

Convenience method for to set the subrange to the items intersecting the given range.

### Parameters

range - a DatumRange

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]

## setIndex

setIndex( int index ) → void

Set the index explicitly.

### Parameters

index - an int

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]

## setQCFilter

setQCFilter( String s ) → void

string containing combination of "opi" meaning that each should be shown. "" will show everything. The list can include:

- o okay are shown
- p problem are shown
- i ignore are shown
- u is unknown/unmarked

### Parameters

s - a String

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]

## setQCFolder

setQCFolder( java.net.URI folder ) → void

### Parameters

folder - an URI

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]

## setSelectedIndeces

setSelectedIndeces( java.util.List sel ) → void

### Parameters

sel - a java.util.List

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]

## setShowMissing

setShowMissing( boolean showMissing ) → void

### Parameters

showMissing - a boolean

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]

## setTimerange

setTimerange( DatumRange timerange ) → void

constraint for the limit of the time ranges listed. Note timespan is what was found.

### Parameters

timerange - a DatumRange

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]

## setUseSubRange

setUseSubRange( boolean useSubRange ) → void

### Parameters

useSubRange - a boolean

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]

## size

size( ) → int

return the number of images in the sequence.

### Returns:

the number of images in the sequence.
[search for examples] [view on GitHub] [view on old javadoc]

## skipBy

skipBy( int n ) → void

Skip forward or backward by the specified number of images. Positive numbers skip forward; negative skip backward. If skipping the requested number of frames would put the index out of range, the skip moves to the last or first image, as appropriate.

### Parameters

n - The number of images to skip.

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]

## toString

toString( ) → String

### Returns:

java.lang.String
[search for examples] [view on GitHub] [view on old javadoc]