All Packages Class Hierarchy This Package Previous Next Index
Class com.ibm.beans.script.ide.SCRIDE
java.lang.Object
|
+----java.awt.Component
|
+----java.awt.Container
|
+----java.awt.Panel
|
+----com.ibm.beans.tools.debugger.BeanFWApp
|
+----com.ibm.beans.script.ide.SCRIDE
- public class SCRIDE
- extends BeanFWApp
- implements FocusListener, ActionListener, SplitPanelListener, SCRIDEInterface
The Scripting IDE class is created by the SCRIDEComponent.
The class can be instantiated
and used for editing scripts of a Scripting Component that
does not have a GUI Editor
associated with it. The SCRIDE class is serializable.
- See Also:
- SCRIDEComponent
-
CHECKBOX_HEIGHT
- The height of the checkbox that specifies if the script is compiled with debugging information.
-
CHECKBOX_WIDTH
- The width of the checkbox that specifies if the script is compiled with debugging information.
-
SCRIDE()
- Creates a Scripting IDE in Frame.
-
SCRIDE(boolean)
- Creates a Scripting IDE with an optional Frame.
-
actionPerformed(ActionEvent)
- This method is the action event handler that gets called when any button
in the SCRIDE is pressed.
-
closeEditor()
- Closes the Editor.
-
componentAdded(SplitPanelEvent)
- Splits the current panel.
-
componentRemoved(SplitPanelEvent)
- Removes the current panel.
-
editScript()
- Edits scripts associated the SCRIDEComponent.
-
getPreferredSize()
- Returns the preferred size of the ide.
-
getScrComponent()
- Gets the SCRIDEComponent associated with this SCRIDE object.
-
getTopPanel()
- Returns the topmost panel of the IDE.
-
handleCommonInit()
- Initializes the graphical user interface and adds the split panel
listener.
-
hasFrame()
- Queries if the SCRIDE has a frame.
-
initialize(SCRIDEComponent)
- Initializes the SCRIDE.
-
instanceAdded(SCRIDEComponentEvent)
- Identifies that an instance was added to the SCRIDEComponent.
-
instanceRemoved(SCRIDEComponentEvent)
- Identifies that an instance was removed from the SCRIDEComponent.
-
instanceRenamed(SCRIDEComponentEvent)
- Identifies that an instance was renamed in the SCRIDEComponent.
-
isDebugChecked()
- Checks if the checkbox that specifies if the script is compiled with debugging information is turned on.
-
openEditor(SCRIDEInstance)
- Edits the passed SCRIDEInstance.
-
readExternal(ObjectInput)
- Reads the object in.
-
runScript(boolean)
- Calls the scripting component to run the script.
-
stopEditingScript()
- Closes scripts associated with the SCRIDEComponent.
-
syncEditor()
- Saves the contents of the active edit session.
-
terminateScript()
- Calls the scripting component to terminate a script.
-
writeExternal(ObjectOutput)
- Writes the object out.
CHECKBOX_WIDTH
public static final int CHECKBOX_WIDTH
- The width of the checkbox that specifies if the script is compiled with debugging information.
CHECKBOX_HEIGHT
public static final int CHECKBOX_HEIGHT
- The height of the checkbox that specifies if the script is compiled with debugging information.
SCRIDE
public SCRIDE()
- Creates a Scripting IDE in Frame.
SCRIDE
public SCRIDE(boolean createFrame)
- Creates a Scripting IDE with an optional Frame.
- Parameters:
- createFrame - true if the SCRIDE should create a frame; false otherwise.
getScrComponent
public SCRIDEComponent getScrComponent()
- Gets the SCRIDEComponent associated with this SCRIDE object.
- Returns:
- The SCRIDEComponent associated with this
SCRIDE object.
- See Also:
- SCRIDEComponent
getTopPanel
public Component getTopPanel()
- Returns the topmost panel of the IDE.
- Returns:
- The top panel of the IDE.
initialize
public void initialize(SCRIDEComponent newScrComponent)
- Initializes the SCRIDE. After construction or serialization
the initialize function must be called before other methods
can be used on the SCRIDE.
- Parameters:
- newScrComponent - The SCRIDEComponent associated with the SCRIDE.
- See Also:
- SCRIDEComponent
editScript
public boolean editScript()
- Edits scripts associated the SCRIDEComponent. This method causes
the SCRIDE GUI to be active and visible.
- Returns:
- true if the SCRIDE was able to become active and
visible; false otherwise.
- See Also:
- SCRIDEComponent
stopEditingScript
public boolean stopEditingScript()
- Closes scripts associated with the SCRIDEComponent. This method causes
the SCRIDE GUI to be deactived and invisible.
- Returns:
- true if the SCRIDE was able to become active and
visible; false otherwise.
- See Also:
- SCRIDEComponent
syncEditor
public synchronized void syncEditor()
- Saves the contents of the active edit session.
If the SCRIDEInstanceEditor is active,
save the current contents of the editor to the SCRIDEInstances
SCRIDEEditableObject. This does not close the editor. It only
flushes the editor contents. This method can be used
before some operation is performed using the SCRIDEInstance
SCRIDEEditableObject data.
- See Also:
- SCRIDEInstance, SCRIDEInstanceEditor, SCRIDEEditableObject
hasFrame
public boolean hasFrame()
- Queries if the SCRIDE has a frame.
- Returns:
- Returns true if the SCRIDE has a frame; false otherwise.
instanceAdded
public void instanceAdded(SCRIDEComponentEvent event)
- Identifies that an instance was added to the SCRIDEComponent.
It is called by the SCRIDEComponent when creating an instance.
- Parameters:
- event - The SCRIDEComponentEvent.
instanceRemoved
public void instanceRemoved(SCRIDEComponentEvent event)
- Identifies that an instance was removed from the SCRIDEComponent.
It is called by the SCRIDEComponent when removing an instance.
- Parameters:
- event - The SCRIDEComponentEvent.
instanceRenamed
public void instanceRenamed(SCRIDEComponentEvent event)
- Identifies that an instance was renamed in the SCRIDEComponent.
It is called by the SCRIDEComponent when renaming an instance.
- Parameters:
- event - The SCRIDEComponentEvent.
openEditor
public synchronized void openEditor(SCRIDEInstance instance)
- Edits the passed SCRIDEInstance. This method creates a
SCRIDEInstanceEditor given a SCRIDEInstance. This method
allows the user to modify a SCRIDEEditableObject associated with
the SCRIDEInstance. If the editor is already created, the contents
of the previous edit session are saved and the editor allows
editing of the passed SCRIDEInstance.
- Parameters:
- instance - The instance to be edited.
- See Also:
- SCRIDEInstance, SCRIDEInstanceEditor, SCRIDEEditableObject
closeEditor
public synchronized void closeEditor()
- Closes the Editor. This method terminates the current edit session
(SCRIDEInstanceEditor).
This method is called when the editor is about to be destroyed.
If the editor is created, the contents of the previous edit session
are saved.
- See Also:
- SCRIDEInstanceEditor
runScript
protected void runScript(boolean runDebug)
- Calls the scripting component to run the script. This method is called when
the Run button is pressed.
- Parameters:
- runDebug - true if script is run with the debugger, false otherwise.
terminateScript
protected void terminateScript()
- Calls the scripting component to terminate a script. This method is called
when the Terminate button is pressed.
componentAdded
public synchronized void componentAdded(SplitPanelEvent event)
- Splits the current panel. This method is called when a panel is added in
the SplitPanel view
- Parameters:
- event - Event fired by the split panel when a new component is added.
componentRemoved
public synchronized void componentRemoved(SplitPanelEvent event)
- Removes the current panel. This method is called when a panel is removed
in the SplitPanel view.
This method ensures that the SCRIDEInstanceEditor data is saved when
it is removed from the SplitPanel view.
- Parameters:
- event - Event fired by the split panel when a component is removed.
writeExternal
public void writeExternal(ObjectOutput out) throws IOException
- Writes the object out.
- Parameters:
- out - The output stream.
- Throws: IOException
- A streaming output error.
- Overrides:
- writeExternal in class BeanFWApp
readExternal
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
- Reads the object in.
- Parameters:
- in - The input stream.
- Throws: IOException
- A streaming input error.
- Throws: ClassNotFoundException
- Class not found during streaming.
- Overrides:
- readExternal in class BeanFWApp
handleCommonInit
protected void handleCommonInit()
- Initializes the graphical user interface and adds the split panel
listener.
getPreferredSize
public Dimension getPreferredSize()
- Returns the preferred size of the ide.
- Returns:
- The preferred size.
- Overrides:
- getPreferredSize in class BeanFWApp
actionPerformed
public void actionPerformed(ActionEvent event)
- This method is the action event handler that gets called when any button
in the SCRIDE is pressed.
- Parameters:
- event - The action event object.
- Overrides:
- actionPerformed in class BeanFWApp
isDebugChecked
public boolean isDebugChecked()
- Checks if the checkbox that specifies if the script is compiled with debugging information is turned on.
- Returns:
- true if the script is compiled with debugging information; false otherwise.
All Packages Class Hierarchy This Package Previous Next Index