BaseEditor (sakai-portal-api 12.2 API)

java.lang.Object
- org.sakaiproject.portal.api.BaseEditor

All Implemented Interfaces:

Editor
```
public class BaseEditor
extends Object
implements Editor
```
Nominal implementation of the Editor interface. This should suffice for typical usage where only the values are needed without additional logic.

Constructor Summary

Constructors
Constructor and Description
`BaseEditor()`
`BaseEditor(String id, String name, String editorUrl, String launchUrl)`
`BaseEditor(String id, String name, String editorUrl, String launchUrl, String preloadScript)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getEditorUrl()` Retrieve the URL of the Editor's primary script.
`String`	`getId()` Retrieve the unique identifier of this Editor.
`String`	`getLaunchUrl()` Retrieve the URL of the Sakai launch script for this Editor.
`String`	`getName()` Retrieve the formal name of this Editor.
`String`	`getPreloadScript()` Retrieve any inline script that should be run before loading this Editor.
`int`	`hashCode()`
`void`	`setEditorUrl(String editorUrl)`
`void`	`setId(String id)`
`void`	`setLaunchUrl(String launchUrl)`
`void`	`setName(String name)`
`void`	`setPreloadScript(String preloadScript)`

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

- Constructor Detail
  - BaseEditor
```
public BaseEditor()
```
  - BaseEditor
```
public BaseEditor(String id,
                  String name,
                  String editorUrl,
                  String launchUrl)
```
  - BaseEditor
```
public BaseEditor(String id,
                  String name,
                  String editorUrl,
                  String launchUrl,
                  String preloadScript)
```
- Method Detail
  - setId
```
public void setId(String id)
```
  - getId
```
public String getId()
```
    Description copied from interface: Editor
    
    Retrieve the unique identifier of this Editor. The ID should be human readable and serves as the system selector for a given editor. It is suggested that the ID be all lower case, alphabetical with optional dashes. The EditorRegistry is case-insensitive for all IDs.
    
    Specified by:
    
    getId in interface Editor
    
    Returns:
    
    the String ID of this Editor.
  - setName
```
public void setName(String name)
```
  - getName
```
public String getName()
```
    Description copied from interface: Editor
    
    Retrieve the formal name of this Editor. The name of an editor includes any stylistic capitalization or spaces as appropriate for a label in an interface.
    
    Specified by:
    
    getName in interface Editor
    
    Returns:
    
    The String name of the Editor as for UI or formal identification.
  - setEditorUrl
```
public void setEditorUrl(String editorUrl)
```
  - getEditorUrl
```
public String getEditorUrl()
```
    Description copied from interface: Editor
    
    Retrieve the URL of the Editor's primary script. The Editor URL is what must be included for any number of editor instances to be used on a given page. If multiple files are required, this should be a loader.
    
    Specified by:
    
    getEditorUrl in interface Editor
    
    Returns:
    
    The main script URL for this Editor.
  - setLaunchUrl
```
public void setLaunchUrl(String launchUrl)
```
  - getLaunchUrl
```
public String getLaunchUrl()
```
    Description copied from interface: Editor
    
    Retrieve the URL of the Sakai launch script for this Editor. The Launch URL points to a script that implements the Sakai binding for an editor. This implementation allows UI toolkits to use a consistent interface for loading various editors.
    
    Specified by:
    
    getLaunchUrl in interface Editor
    
    Returns:
    
    The launch script URL for this Editor.
  - setPreloadScript
```
public void setPreloadScript(String preloadScript)
```
  - getPreloadScript
```
public String getPreloadScript()
```
    Description copied from interface: Editor
    
    Retrieve any inline script that should be run before loading this Editor. In some cases, an editor may depend on environmental setup before loading the main script file. This offers an opportunity to supply such pre-loading script as inline markup. It should not include any
    - Summary:
    - Nested |
    - Field |
    - Constr |
    - Method
    - Detail:
    - Field |
    - Constr |
    - Method

Class BaseEditor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BaseEditor

BaseEditor

BaseEditor

Method Detail

setId

getId

setName

getName

setEditorUrl

getEditorUrl

setLaunchUrl

getLaunchUrl

setPreloadScript

getPreloadScript