com.simplifiedlogic.nitro.util

Class View2DLooper

java.lang.Object

com.simplifiedlogic.nitro.util.LooperBase

com.simplifiedlogic.nitro.util.View2DLooper

public abstract class View2DLooper
extends LooperBase

This is an abstract class which loops over views on a drawing, filters the results by various filters, and calls an action method for each drawing view which matches the filters.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	singleOp Output flag indicating that only a single parameter was specified in the name filter

Fields inherited from class com.simplifiedlogic.nitro.util.LooperBase

currentName, debugKey, isNameEntryPattern, isNamePattern, nameList, namePattern

Constructor Summary

Constructors

Constructor and Description
View2DLooper()

Method Summary

Methods

Modifier and Type	Method and Description
CallModel2D	getDrawing()
int	getSheetno()
void	loop() Loop through views in a drawing
abstract boolean	loopAction(CallView2D view) Abstract function which is called for each drawing view which matches the filters.
protected void	processObjectByName(java.lang.String name) Abstract function which is called for each object whose name matches the filters.
void	setDrawing(CallModel2D drawing)
void	setSheetno(int sheetno)

Methods inherited from class com.simplifiedlogic.nitro.util.LooperBase

checkName, checkName, checkNameAgainstList, checkNameAgainstList, getDebugKey, getIsNamePattern, getNameList, getNamePattern, setDebugKey, setIsNamePattern, setNameList, setNameList, setNamePattern

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

singleOp

public boolean singleOp

Output flag indicating that only a single parameter was specified in the name filter

Constructor Detail

View2DLooper

public View2DLooper()

Method Detail

loop

public void loop()
          throws JLIException,
                 com.ptc.cipjava.jxthrowable

Loop through views in a drawing

Throws:

JLIException

com.ptc.cipjava.jxthrowable

loopAction

public abstract boolean loopAction(CallView2D view)
                            throws JLIException,
                                   com.ptc.cipjava.jxthrowable

Abstract function which is called for each drawing view which matches the filters. This must be implemented by a class extending this looper class.

Parameters:

view - The drawing view that matches the filters

Returns:

True to abort the loop, false to continue it

Throws:

JLIException

com.ptc.cipjava.jxthrowable

processObjectByName

protected void processObjectByName(java.lang.String name)
                            throws JLIException,
                                   com.ptc.cipjava.jxthrowable

Description copied from class: LooperBase

Abstract function which is called for each object whose name matches the filters. This must be implemented by a class extending this looper class, though many implementers use a dummy method. May be used to force a call to loopAction for a specific name.

Specified by:

processObjectByName in class LooperBase

Parameters:

name - The name of the object that matched the filters

Throws:

JLIException

com.ptc.cipjava.jxthrowable

getDrawing

public CallModel2D getDrawing()

Returns:

The drawing that owns the views

setDrawing

public void setDrawing(CallModel2D drawing)

Parameters:

drawing - The drawing that owns the views

getSheetno

public int getSheetno()

Returns:

The sheet number filter

setSheetno

public void setSheetno(int sheetno)

Parameters:

sheetno - The sheet number filter