TKSnapPreview Class Reference
Base class for Snap2 preview frames. More...
Public Member Functions | |
| __construct ($version, $mode=self::MODE_DEFAULT) | |
| Base constructor for previews. | |
Protected Member Functions | |
| getFormattedSource () | |
| Generates an HTML display of the content in some usable format. | |
| getParameters ($name) | |
| Retrieves parameter arrays for translators. | |
| getTranslators () | |
| Returns array of translator pretty and ugly names. | |
| showAdditionalInfo () | |
| Displays additional information about the version. | |
Detailed Description
Base class for Snap2 preview frames.The preview frame shows the user what the content will look like through various translators, and also displays the source and other information about the content. This component can easily be dropped in to show content previews and is used by the Snap2 editors so that a preview of the latest revision of the content can be display.
Constructor & Destructor Documentation
| TKSnapPreview::__construct | ( | $ | version, | |
| $ | mode = self::MODE_DEFAULT | |||
| ) |
Base constructor for previews.
You should not override this constructor in derived classes
- Parameters:
-
$version [SnapVersion]: version whose content is being previewed $mode [int]: preview mode: can be either TKSnapPreview::MODE_DEFAULT or TKSnapPreview::MODE_BASIC
Member Function Documentation
| TKSnapPreview::getFormattedSource | ( | ) | [abstract, protected] |
Generates an HTML display of the content in some usable format.
The preview frame in the Snap2 admin tool has a Formatted Source tab which shows the source (non-translated) in some way that is visually appealing. For XML/HTML content, the source should probably remain intact, albeit with syntax highlighting and the like. For other types of content, a more descriptive approach should be used, such as a table listing all of the attributes stored in the database.
- Returns:
- [string]: string of HTML to be shown in Formatted Source tab of preview frame
Reimplemented in TKSnapCssPreview, TKSnapHtmlPreview, TKSnapInteractivateInstructorPreview, TKSnapInteractivateLessonPreview, TKSnapLessonPlanPreview, TKSnapMediaAgentsheetsPreview, TKSnapMediaDocumentPreview, TKSnapMediaFilePreview, TKSnapMediaImagePreview, TKSnapMediaInteractivatePreview, TKSnapMediaNetlogoPreview, and TKSnapXmlPreview.
| TKSnapPreview::getParameters | ( | $ | name | ) | [protected] |
Retrieves parameter arrays for translators.
A translator may need additional parameters. If so, then override this method and return an array of additional parameters to be passed to $prm->load(). The '$name' argument is the "pretty name" displayed in the drop down. If no extra parameters need to be passed, just return an empty array.
- Parameters:
-
$name [string]: pretty name whose parameters need to be retrieved
- Returns:
- [array]: array of additional parameters, or empty array() if there are none
Reimplemented in TKSnapMediaImagePreview.
| TKSnapPreview::getTranslators | ( | ) | [abstract, protected] |
Returns array of translator pretty and ugly names.
The array returned must be associative. The key for each element is the pretty name to be displayed in the translator drop down in the preview frame. The value is the name of the translator class (the 'ugly' name). You do not need to include entries for Formatted Source and Raw Source as these are generated automatically.
Reimplemented in TKSnapCssPreview, TKSnapHtmlPreview, TKSnapInteractivateInstructorPreview, TKSnapInteractivateLessonPreview, TKSnapLessonPlanPreview, TKSnapMediaAgentsheetsPreview, TKSnapMediaDocumentPreview, TKSnapMediaFilePreview, TKSnapMediaImagePreview, TKSnapMediaInteractivatePreview, TKSnapMediaNetlogoPreview, and TKSnapXmlPreview.
| TKSnapPreview::showAdditionalInfo | ( | ) | [protected] |
Displays additional information about the version.
The additional information may be a table of attributes, or media tags, etc. If you do not need to display any additional information, then do not override this function (the default implementation displays nothing). Return a toolkit component which will be added at the appropriate place in the page. Return null if nothing is to be displayed.
- Returns:
- [TKComponent]: Toolkit component with additional information, or null if none is to be displayed
Reimplemented in TKSnapMediaAgentsheetsPreview, TKSnapMediaDocumentPreview, TKSnapMediaFilePreview, TKSnapMediaImagePreview, TKSnapMediaInteractivatePreview, and TKSnapMediaNetlogoPreview.
The documentation for this class was generated from the following file:
- snap2/tk2/previews/TKSnapPreview.php5
