java.lang.Object
- org.jmol.popup.GenericPopup
- - org.jmol.popup.JmolGenericPopup
  - - org.jmol.modelkit.ModelKitPopup

All Implemented Interfaces:

GenericMenuInterface

Direct Known Subclasses:

AwtModelKitPopup, JSModelKitPopup
```
public abstract class ModelKitPopup
extends JmolGenericPopup
```
An abstract popup class that is instantiated for a given platform and context as one of:
```
   -- abstract ModelKitPopup
      -- AwtModelKitPopup
      -- JSModelKitPopup
 
```

Field Summary

Fields
Modifier and Type	Field	Description
`private String`	`activeMenu`
`private boolean`	`addXtalHydrogens`	when TRUE, add H atoms to C when added to the modelSet.
`private boolean`	`alertedNoEdit`
`private String[]`	`allOperators`
`private String`	`atomHoverLabel`
`private int`	`atomIndexSphere`
`private int`	`bondAtomIndex1`
`private int`	`bondAtomIndex2`
`private String`	`bondHoverLabel`
`private int`	`bondIndex`
`static String`	`BOOLEAN_OPTIONS`
`private int`	`branchAtomIndex`
`private javajs.util.BS`	`bsHighlight`
`private javajs.util.BS`	`bsRotateBranch`
`private static PopupResource`	`bundle`
`private int`	`centerAtomIndex`
`private float`	`centerDistance`
`private javajs.util.P3`	`centerPoint`
`private boolean`	`clickToSetElement`	Except for H atoms, do not allow changes to elements just by clicking them.
`private int`	`currentModelIndex`
`private String`	`drawData`
`private String`	`drawScript`
`private boolean`	`hasUnitCell`
`private int`	`iatom0`
`private boolean`	`isPickAtomAssignCharge`
`private boolean`	`isRotateBond`
`private String`	`lastCenter`
`private ModelSet`	`lastModelSet`
`private String`	`lastOffset`
`private static int`	`MAX_LABEL`
`private Map<String,Object>`	`mkdata`
`static String`	`MODE_OPTIONS`
`private String`	`pickAtomAssignType`
`private String`	`pickBondAssignType`
`private static javajs.util.P3`	`Pt000`
`private float`	`rotationDeg`
`private int[]`	`screenXY`
`private int`	`secondAtomIndex`
`static String`	`SET_OPTIONS`
`private boolean`	`showSymopInfo`
`private javajs.util.P3`	`spherePoint`
`private int`	`state`
`static int`	`STATE_BITS_SYM_EDIT`
`static int`	`STATE_BITS_SYM_VIEW`
`static int`	`STATE_BITS_UNITCELL`
`static int`	`STATE_BITS_XTAL`
`static int`	`STATE_MOLECULAR`
`static int`	`STATE_SYM_APPLYFULL`
`static int`	`STATE_SYM_APPLYLOCAL`
`static int`	`STATE_SYM_NONE`
`static int`	`STATE_SYM_RETAINLOCAL`
`static int`	`STATE_SYM_SHOW`
`static int`	`STATE_UNITCELL_EXTEND`
`static int`	`STATE_UNITCELL_PACKED`
`static int`	`STATE_XTALEDIT`
`static int`	`STATE_XTALVIEW`
`static String`	`SYMMETRY_OPTIONS`
`private Object`	`symop`
`static String`	`UNITCELL_OPTIONS`
`private javajs.util.P3`	`viewOffset`
`private String`	`xtalHoverLabel`

Fields inherited from class org.jmol.popup.JmolGenericPopup
frankPopup, menuText, nFrankList, vwr

Fields inherited from class org.jmol.popup.GenericPopup
allowSignedFeatures, buttonGroup, currentMenuItemId, helper, htCheckbox, htMenus, isApplet, isJS, isSigned, isTainted, isWebGL, menuName, popupMenu, strMenuStructure, thisPopup, thisx, thisy, updatingForShow

Constructor Summary

Constructors
Constructor Description

ModelKitPopup()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`actionRotateBond(int deltaX, int deltaY, int x, int y, boolean forceFull)`	Actually rotate the bond.
`private void`	`addAllCheckboxItems(SC menu, String[] labels)`
`private void`	`addData(String key, Object value)`
`protected boolean`	`appGetBooleanProperty(String name)`
`protected void`	`appUpdateForShow()`
`protected void`	`appUpdateSpecialCheckBoxValue(SC source, String actionCommand, boolean selected)`	Set the active menu based on updating a value -- usually by the user, but also during setup (ignored).
`private void`	`assignAtom(int atomIndex, String type, boolean autoBond, boolean addHsAndBond)`	Original ModelKitPopup functionality -- assign an atom.
`private javajs.util.BS`	`assignBond(int bondIndex, int type)`	Original ModelKit functionality -- assign a bond.
`private boolean`	`checkUpdateSymmetryInfo()`
`void`	`doMenuClickCallbackMK(SC source, String script)`
`String`	`getActiveMenu()`	for FrankRender -- the thin box on the top left
`protected PopupResource`	`getBundle(String menu)`
`private Object`	`getData(String key)`
`private String`	`getHoverLabel(int atomIndex)`	Called by Viewer.hoverOn to set the special label if desired.
`private int`	`getMKState()`
`Object`	`getProperty(Object data)`	Get a property of the modelkit.
`int`	`getRotateBondIndex()`
`protected String`	`getScriptForCallback(SC source, String id, String script)`	Secondary processing of menu item click
`private int`	`getSymEditState()`
`private int`	`getSymViewState()`
`private int`	`getUnitCellState()`
`String`	`getUnknownCheckBoxScriptToRun(SC item, String name, String what, boolean TF)`	From JmolGenericPopup.appRunSpecialCheckBox when name starts with "mk" or has "??" in it.
`private int`	`getViewState()`
`boolean`	`handleAssignNew(MouseState pressed, MouseState dragged, MeasurementPending mp, int dragAtomIndex)`	C
`boolean`	`handleDragAtom(MouseState pressed, MouseState dragged, int[] countPlusIndices)`	Called from ActionManager for a drag-drop
`protected void`	`initialize(Viewer vwr, PopupResource bundle, String title)`
`void`	`initializeForModel()`
`boolean`	`isPickAtomAssignCharge()`
`private static boolean`	`isTrue(Object value)`
`private boolean`	`isVwrRotateBond()`
`private boolean`	`isXtalState()`
`void`	`jpiUpdateComputedMenus()`
`void`	`menuClickCallback(SC source, String script)`
`void`	`menuFocusCallback(String name, String actionCommand, boolean gained)`
`private static void`	`notImplemented(String action)`
`private static javajs.util.P3`	`pointFromTriad(String pos)`
`private boolean`	`processAtomClick(int atomIndex)`	An atom has been clicked -- handle it.
`private void`	`processMKPropertyItem(String name, boolean TF)`
`private void`	`processModeClick(String action)`
`private void`	`processSelClick(String action)`
`private void`	`processSelOpClick(String action)`
`private void`	`processSymClick(String action)`
`private boolean`	`processSymop(String id, boolean isFocus)`
`private void`	`processUCClick(String action)`
`private void`	`processXtalClick(String id, String action)`
`private String`	`promptUser(String msg, String def)`
`private void`	`resetBondFields(String where)`
`private String`	`runScriptBuffered(String script)`
`String`	`setActiveMenu(String name)`	Set the active menu and request a repaint.
`private void`	`setBondIndex(int index, boolean isRotate)`	Set the bond for rotation -- called by Sticks.checkObjectHovered via Viewer.highlightBond.
`private void`	`setDefaultState(int mode)`
`private void`	`setLabel(String key, String label)`
`private void`	`setMKState(int bits)`
`Object`	`setProperty(String name, Object value)`	Modify the state by setting a property -- primarily from CmdExt.modelkit.
`private void`	`setSymEdit(int bits)`
`private void`	`setSymViewState(int bits)`
`private void`	`setUnitCell(int bits)`
`private void`	`showSymop(Object symop)`
`private void`	`showXtalSymmetry()`	Draw the symmetry element
`private void`	`updateAllXtalMenuOptions()`
`private void`	`updateAllXtalMenus()`
`private void`	`updateOperatorMenu()`

Methods inherited from class org.jmol.popup.JmolGenericPopup
appFixLabel, appRestorePopupMenu, appRunScript, appRunSpecialCheckBox, jpiDispose, jpiGetMenuAsObject, jpiInitialize, jpiShow, showFrankMenu

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

hasUnitCell
```
private boolean hasUnitCell
```

allOperators
```
private String[] allOperators
```

currentModelIndex
```
private int currentModelIndex
```

alertedNoEdit
```
private boolean alertedNoEdit
```

atomHoverLabel
```
private String atomHoverLabel
```

bondHoverLabel
```
private String bondHoverLabel
```

xtalHoverLabel
```
private String xtalHoverLabel
```

activeMenu
```
private String activeMenu
```

lastModelSet
```
private ModelSet lastModelSet
```

pickAtomAssignType
```
private String pickAtomAssignType
```

pickBondAssignType
```
private String pickBondAssignType
```

isPickAtomAssignCharge
```
private boolean isPickAtomAssignCharge
```

bsHighlight
```
private javajs.util.BS bsHighlight
```

bondIndex
```
private int bondIndex
```

bondAtomIndex1
```
private int bondAtomIndex1
```

bondAtomIndex2
```
private int bondAtomIndex2
```

bsRotateBranch
```
private javajs.util.BS bsRotateBranch
```

branchAtomIndex
```
private int branchAtomIndex
```

isRotateBond
```
private boolean isRotateBond
```

screenXY
```
private int[] screenXY
```

mkdata
```
private Map<String,Object> mkdata
```

showSymopInfo
```
private boolean showSymopInfo
```

addXtalHydrogens
```
private boolean addXtalHydrogens
```
when TRUE, add H atoms to C when added to the modelSet.

clickToSetElement
```
private boolean clickToSetElement
```
Except for H atoms, do not allow changes to elements just by clicking them. This protects against doing that inadvertently when editing.

centerPoint
```
private javajs.util.P3 centerPoint
```

spherePoint
```
private javajs.util.P3 spherePoint
```

viewOffset
```
private javajs.util.P3 viewOffset
```

centerDistance
```
private float centerDistance
```

symop
```
private Object symop
```

centerAtomIndex
```
private int centerAtomIndex
```

secondAtomIndex
```
private int secondAtomIndex
```

atomIndexSphere
```
private int atomIndexSphere
```

drawData
```
private String drawData
```

drawScript
```
private String drawScript
```

iatom0
```
private int iatom0
```

MAX_LABEL
```
private static final int MAX_LABEL
```
See Also:

Constant Field Values

bundle
```
private static PopupResource bundle
```

STATE_BITS_XTAL
```
public static final int STATE_BITS_XTAL
```
See Also:

Constant Field Values

STATE_MOLECULAR
```
public static final int STATE_MOLECULAR
```
See Also:

Constant Field Values

STATE_XTALVIEW
```
public static final int STATE_XTALVIEW
```
See Also:

Constant Field Values

STATE_XTALEDIT
```
public static final int STATE_XTALEDIT
```
See Also:

Constant Field Values

STATE_BITS_SYM_VIEW
```
public static final int STATE_BITS_SYM_VIEW
```
See Also:

Constant Field Values

STATE_SYM_NONE
```
public static final int STATE_SYM_NONE
```
See Also:

Constant Field Values

STATE_SYM_SHOW
```
public static final int STATE_SYM_SHOW
```
See Also:

Constant Field Values

STATE_BITS_SYM_EDIT
```
public static final int STATE_BITS_SYM_EDIT
```
See Also:

Constant Field Values

STATE_SYM_APPLYLOCAL
```
public static final int STATE_SYM_APPLYLOCAL
```
See Also:

Constant Field Values

STATE_SYM_RETAINLOCAL
```
public static final int STATE_SYM_RETAINLOCAL
```
See Also:

Constant Field Values

STATE_SYM_APPLYFULL
```
public static final int STATE_SYM_APPLYFULL
```
See Also:

Constant Field Values

STATE_BITS_UNITCELL
```
public static final int STATE_BITS_UNITCELL
```
See Also:

Constant Field Values

STATE_UNITCELL_PACKED
```
public static final int STATE_UNITCELL_PACKED
```
See Also:

Constant Field Values

STATE_UNITCELL_EXTEND
```
public static final int STATE_UNITCELL_EXTEND
```
See Also:

Constant Field Values

MODE_OPTIONS

public static final String MODE_OPTIONS

See Also:: Constant Field Values

SYMMETRY_OPTIONS

public static final String SYMMETRY_OPTIONS

See Also:: Constant Field Values

UNITCELL_OPTIONS

public static final String UNITCELL_OPTIONS

See Also:: Constant Field Values

BOOLEAN_OPTIONS

public static final String BOOLEAN_OPTIONS

See Also:: Constant Field Values

SET_OPTIONS
```
public static final String SET_OPTIONS
```
See Also:

Constant Field Values

Pt000

private static final javajs.util.P3 Pt000

state
```
private int state
```

rotationDeg
```
private float rotationDeg
```

lastCenter
```
private String lastCenter
```

lastOffset
```
private String lastOffset
```

Constructor Detail
- ModelKitPopup
```
public ModelKitPopup()
```

Method Detail

initialize

protected void initialize(Viewer vwr,
                          PopupResource bundle,
                          String title)

Overrides:: initialize in class JmolGenericPopup

getBundle

protected PopupResource getBundle(String menu)

Specified by:: getBundle in class JmolGenericPopup

initializeForModel
```
public void initializeForModel()
```

jpiUpdateComputedMenus
```
public void jpiUpdateComputedMenus()
```

appUpdateForShow
```
protected void appUpdateForShow()
```
Specified by:

appUpdateForShow in class GenericPopup

checkUpdateSymmetryInfo

private boolean checkUpdateSymmetryInfo()

updateAllXtalMenus
```
private void updateAllXtalMenus()
```

updateOperatorMenu
```
private void updateOperatorMenu()
```

addAllCheckboxItems

private void addAllCheckboxItems(SC menu,
                                 String[] labels)

updateAllXtalMenuOptions

private void updateAllXtalMenuOptions()

setLabel

private void setLabel(String key,
                      String label)

getActiveMenu
```
public String getActiveMenu()
```
for FrankRender -- the thin box on the top left

Returns:

[ "atomMenu" | "bondMenu" | "xtalMenu" | null ]

setActiveMenu
```
public String setActiveMenu(String name)
```
Set the active menu and request a repaint.

Parameters:

name -

Returns:

activeMenu or null

appUpdateSpecialCheckBoxValue

protected void appUpdateSpecialCheckBoxValue(SC source,
                                             String actionCommand,
                                             boolean selected)

Set the active menu based on updating a value -- usually by the user, but also during setup (ignored).

Specified by:: appUpdateSpecialCheckBoxValue in class GenericPopup

isXtalState
```
private boolean isXtalState()
```

setMKState
```
private void setMKState(int bits)
```

getMKState
```
private int getMKState()
```

setSymEdit
```
private void setSymEdit(int bits)
```

getSymEditState
```
private int getSymEditState()
```

getViewState
```
private int getViewState()
```

setSymViewState

private void setSymViewState(int bits)

getSymViewState
```
private int getSymViewState()
```

setUnitCell

private void setUnitCell(int bits)

getUnitCellState
```
private int getUnitCellState()
```

isPickAtomAssignCharge

public boolean isPickAtomAssignCharge()

getProperty
```
public Object getProperty(Object data)
```
Get a property of the modelkit.

Parameters:

data - a name or an array with [name, value]

Returns:

value

setProperty
```
public Object setProperty(String name,
                          Object value)
```
Modify the state by setting a property -- primarily from CmdExt.modelkit. Also can be used for "get" purposes.

Parameters:

name -

value -

Returns:

null or "get" value

isTrue

private static boolean isTrue(Object value)

getData

private Object getData(String key)

addData

private void addData(String key,
                     Object value)

processAtomClick
```
private boolean processAtomClick(int atomIndex)
```
An atom has been clicked -- handle it. Called from CmdExt.assignAtom from the script created in ActionManager.assignNew from Actionmanager.checkReleaseAction

Parameters:

atomIndex -

Returns:

true if handled

getHoverLabel
```
private String getHoverLabel(int atomIndex)
```
Called by Viewer.hoverOn to set the special label if desired.

Parameters:

atomIndex -

Returns:

special label or null

setDefaultState

private void setDefaultState(int mode)

appGetBooleanProperty
```
protected boolean appGetBooleanProperty(String name)
```
Overrides:

appGetBooleanProperty in class JmolGenericPopup

getUnknownCheckBoxScriptToRun

public String getUnknownCheckBoxScriptToRun(SC item,
                                            String name,
                                            String what,
                                            boolean TF)

From JmolGenericPopup.appRunSpecialCheckBox when name starts with "mk" or has "??" in it.

Specified by:: getUnknownCheckBoxScriptToRun in class GenericPopup

processMKPropertyItem

private void processMKPropertyItem(String name,
                                   boolean TF)

showXtalSymmetry
```
private void showXtalSymmetry()
```
Draw the symmetry element

assignAtom

private void assignAtom(int atomIndex,
                        String type,
                        boolean autoBond,
                        boolean addHsAndBond)

Original ModelKitPopup functionality -- assign an atom.

Parameters:: atomIndex -; type -; autoBond -; addHsAndBond -

assignBond
```
private javajs.util.BS assignBond(int bondIndex,
                                  int type)
```
Original ModelKit functionality -- assign a bond.

Parameters:

bondIndex -

type -

Returns:

bit set of atoms to modify

isVwrRotateBond
```
private boolean isVwrRotateBond()
```

getRotateBondIndex
```
public int getRotateBondIndex()
```

resetBondFields

private void resetBondFields(String where)

setBondIndex
```
private void setBondIndex(int index,
                          boolean isRotate)
```
Set the bond for rotation -- called by Sticks.checkObjectHovered via Viewer.highlightBond.

Parameters:

index -

isRotate -

actionRotateBond

public void actionRotateBond(int deltaX,
                             int deltaY,
                             int x,
                             int y,
                             boolean forceFull)

Actually rotate the bond. Called by ActionManager.checkDragWheelAction.

Parameters:: deltaX -; deltaY -; x -; y -

menuFocusCallback

public void menuFocusCallback(String name,
                              String actionCommand,
                              boolean gained)

Specified by:: menuFocusCallback in class GenericPopup

menuClickCallback

public void menuClickCallback(SC source,
                              String script)

Overrides:: menuClickCallback in class GenericPopup

doMenuClickCallbackMK

public void doMenuClickCallbackMK(SC source,
                                  String script)

getScriptForCallback

protected String getScriptForCallback(SC source,
                                      String id,
                                      String script)

Secondary processing of menu item click

Specified by:: getScriptForCallback in class GenericPopup

processXtalClick

private void processXtalClick(String id,
                              String action)

processSelOpClick

private void processSelOpClick(String action)

processSymop

private boolean processSymop(String id,
                             boolean isFocus)

showSymop

private void showSymop(Object symop)

processModeClick

private void processModeClick(String action)

processSelClick

private void processSelClick(String action)

processSymClick

private void processSymClick(String action)

processUCClick

private void processUCClick(String action)

handleDragAtom

public boolean handleDragAtom(MouseState pressed,
                              MouseState dragged,
                              int[] countPlusIndices)

Called from ActionManager for a drag-drop

Parameters:: pressed -; dragged -; countPlusIndices -
Returns:: true if handled here

pointFromTriad

private static javajs.util.P3 pointFromTriad(String pos)

notImplemented

private static void notImplemented(String action)

promptUser

private String promptUser(String msg,
                          String def)

runScriptBuffered

private String runScriptBuffered(String script)

handleAssignNew

public boolean handleAssignNew(MouseState pressed,
                               MouseState dragged,
                               MeasurementPending mp,
                               int dragAtomIndex)

C

Parameters:: pressed -; dragged -; mp -; dragAtomIndex -
Returns:: true if we should do a refresh now

Class ModelKitPopup

Field Summary

Fields inherited from class org.jmol.popup.JmolGenericPopup

Fields inherited from class org.jmol.popup.GenericPopup

Constructor Summary

Method Summary

Methods inherited from class org.jmol.popup.JmolGenericPopup

Methods inherited from class org.jmol.popup.GenericPopup

Methods inherited from class java.lang.Object

Field Detail

hasUnitCell

allOperators

currentModelIndex

alertedNoEdit

atomHoverLabel

bondHoverLabel

xtalHoverLabel

activeMenu

lastModelSet

pickAtomAssignType

pickBondAssignType

isPickAtomAssignCharge

bsHighlight

bondIndex

bondAtomIndex1

bondAtomIndex2

bsRotateBranch

branchAtomIndex

isRotateBond

screenXY

mkdata

showSymopInfo

addXtalHydrogens

clickToSetElement

centerPoint

spherePoint

viewOffset

centerDistance

symop

centerAtomIndex

secondAtomIndex

atomIndexSphere

drawData

drawScript

iatom0

MAX_LABEL

bundle

STATE_BITS_XTAL

STATE_MOLECULAR

STATE_XTALVIEW

STATE_XTALEDIT

STATE_BITS_SYM_VIEW

STATE_SYM_NONE

STATE_SYM_SHOW

STATE_BITS_SYM_EDIT

STATE_SYM_APPLYLOCAL

STATE_SYM_RETAINLOCAL

STATE_SYM_APPLYFULL

STATE_BITS_UNITCELL

STATE_UNITCELL_PACKED

STATE_UNITCELL_EXTEND

MODE_OPTIONS

SYMMETRY_OPTIONS

UNITCELL_OPTIONS

BOOLEAN_OPTIONS

SET_OPTIONS

Pt000

state

rotationDeg

lastCenter

lastOffset

Constructor Detail

ModelKitPopup

Method Detail

initialize

getBundle

initializeForModel

jpiUpdateComputedMenus

appUpdateForShow

checkUpdateSymmetryInfo