Sferyx JSyndrome Java CSS Editor and Style Sheet Editor Component Edition

User Manual for Java Swing Integration of the Sferyx CSS Editor and Style Sheet Editor Component

Sferyx Java CSS Editor and Style Sheet Editor Component

Note: In the demo version most of the development API is disabled - the retail product comes with full API available for development which allows full customization of the editor as well to implement any additional functionalities needed. Contact support@sferyx.com if you are interested in receiving the full javadoc for review of the available functionalities.

The Sferyx JSyndrome CSSEditor Component Edition has been released in one version intended for broad range of applications as a component and also could be used as a standalone CSS and Style Sheet editor application if needed. If you intend to use it as component within an application then you can consult the javadoc documentation supplied with the product - it can be inserted as visual java bean into the editing environments such as Forte for Java, JBuilder or similar. It is sufficient to add the jar file to the component palette of the IDE and the icon of the CSSEditor should appear on the toolbar. The demo version is restricted and cannot be customized, it also takes automatically the default system look & feel. The retail versions instead feature different visual options for full customization of the user interface such as showing/hiding of the main menu, toolbars, popup menu, source editor also inserting of initial CSS content etc.

Sample documentation:

Available packages:

Class Summary
`sferyx.csseditor.CSSEditorComponent`	The main CSSEditorComponent which include the basic functionalities for editing CSS content visually
`sferyx.csseditor.CSSEditorComponentSource`	CSSEditorComponentSource includes the CSSEditorComponent and also the Source editor for editing CSS content
`sferyx.csseditor.CSSEditorRootPane`	Fully featured visual CSSEditor Component which includes the CSSEditorComponent, the Source Editor, all the menus and toolbars for loading and editing CSS files
`sferyx.csseditor.CssParser`	CssParser implementation
`sferyx.csseditor.CSSSourceEditorDocument`	Document for visualizing highlighted CSS sources.
`sferyx.csseditor.CSSUtilities`	Various CSS handling utilities
`sferyx.csseditor.CustomCSSParser`	Custom CSS parser for handling complex CSS files
`sferyx.csseditor.CustomStyleSheet`	Customized StyleSheet implementation
`sferyx.csseditor.DashedBorder`	Dashed border implementation
`sferyx.csseditor.Selector`	Additional Selector implementation for future use
`sferyx.csseditor.SferyxUtilities`	Various utilities for handling style sheets
`sferyx.csseditor.StandAloneApplication`	The entry class for the CSSEditor when used as a Stand Alone Application

Method Summary for the class sferyx.csseditor. CSSEditorRootPane
`CSSEditorComponentSource`	`addNewTab()` Ceates new CSSEditor tab with all the features enabled and returns the newly created CSSEditorComponentSource instance
`void`	`copyStyleToClipboard()` Copies CSS selector and all its definitions from in the user's selector list - it can be pasted as new selector as duplicate.
`void`	`createNewWindow()` Ceates new CSSEditor window with all the features enabled.
`void`	`cutStyleToClipboard()` Copies CSS selector and all its definitions and removes it from in the user's selector list - it can be pasted as new selector as duplicate.
`void`	`exit()` Exits the application when needed
`java.lang.Object`	`getContent()` Creates a new instance of PuggableComponent
`java.lang.Class`	`getCSSEditorClass()` Returns the original CSSEditorRootPane class object used to access directly the various class fields.
`java.awt.Image`	`getImage()` empty implementation from the common interface
`java.lang.String`	`getRemovedMenus()` Returns the menus removed previously from the CSSEditor.
`java.lang.String`	`getRemovedToolbarItems()` Returns the previously removed toolbar items.
`CSSEditorComponentSource`	`getSelectedCSSEditorComponentSource()` Returns the currently active CSSEditorComponentSource instance
`sferyx.csseditor.CSSEditorRootPane.WindowController`	`getWindowController()` Returns the WindowController which manages the various CSSEditor window instances
`static void`	`initLookAndFeel()` Initializes the system's default L&F
`boolean`	`isSourceVisible()` Returns whether the CSS source editor of the currently selected CSSEditor component is visible
`void`	`openFile()` Opens existing CSS file with CSS styles definitions to be edited inside the CSSEditor
`void`	`openLocation(java.lang.String cssLocation)` Opens remote CSS file with CSS styles definitions identified by cssLocation String which should be a fully qualified URL to be edited inside the CSSEditor
`void`	`openLocation(java.net.URL cssLocation)` Opens remote CSS file with CSS styles definitions identified by cssLocation URL to be edited inside the CSSEditor
`void`	`pasteStyleFromClipboard()` Pastes previously copied CSS selector and all its definitions as a new CSS selector in the user's selector list.
`boolean`	`saveFile()` Saves the CSS file with CSS styles definitions as a standard CSS text file format
`void`	`saveFile(java.io.File toSaveFile)` Saves the CSS file with CSS styles definitions as a standard CSS text file format
`void`	`setContent(java.lang.Object content)` Sets the inital CSS style sheet to be edited inside the CSSEditor as a standard CSS formatted text string or javax.swing.text.html.StyleSheet object
`void`	`setContent(java.lang.String css)` Sets the inital CSS style sheet rto be edited inside the CSSEditor as a standard CSS formatted text string
`void`	`setMainMenuVisible(boolean visible)` Shows or hides the main menu of the CSSEditor component.
`void`	`setRemovedMenuItems(java.lang.String menuItemNames)` setRemovedMenuItems("OpenMenuItem, ExitMenuItem, PasteMenuItem,...") - Indicates which menu items should be removed from the menus.
`void`	`setRemovedMenus(java.lang.String menuItemNames)` setRemovedMenus("FileMenu, EditMenu,..") - Indicates which menus should be removed from the main menu bar.
`void`	`setRemovedToolbarItems(java.lang.String toolbarItemNames)` setRemovedToolbarItems("OpenButton,CopyButton,AddSelectorButton...") - Indicates which toolbar items should be removed from the tool bars.
`void`	`setShowHiddenToolbarItems(java.lang.String toolbarItemNames)` setShowHiddenToolbarItems(String toolbarItemNames) - Indicates which menu items should be shown again after being previously hidden.
`void`	`setSourceVisible(boolean visible)` Shows or hides the CSS source editor of the currently selected CSSEditor component
`void`	`setToolbarVisible(boolean visible)` Shows or hides the main toolbar of the CSSEditor component

Compatibility

The Sferyx JSyndrome CSSEditor has been written and tested under JDK 1.4 / 1.5 / 1.6 / 1.7 / 1.8 / 9 / 10 / 11 / 12 / 13 /14 / 15 / 16 and higher. It is recommended using these versions of the JDK or higher as it uses features not presented into the earlier versions of the JDK. It has been tested on various versions of Windows such as Windows 98, Windows Me, Windows 2000, Windows XP, Windows Vista, 7,8, 10, Linux, Solaris and MacOS X 10.x.

Manipulating the CSS Editor content and UI

There are some of the available functions:

public void setContent(java.lang.String cssContent)- sets the content of the CSSEditor. The content should be an well formatted CSS style sheet document.public String getContent() - returns the content of the CSSEditor editor as entire CSS document.

public void setContent(Object content)- sets the content of the CSSEditor - if it is instance of String it will be imported as standard CSS text file, if it is an instance of StyleSheet it will be edited directly.

public void setMainMenuVisible(boolean visible) - enables/disables the main menu. It could be used in order to customize the UI of the CSS editor as necessary.

public void setSourceVisible(boolean visible)- enables/disables the source editor. It could be used in order to customize the UI of the CSS editor as necessary.public void setToolbarVisible(boolean visible) - enables/disables the toolbar. It could be used in order to customize the UI of the CSS editor as necessary.

public JToolBar getToolbar() -returns the toolbar used inside the visual editor. This allows easy customization of the toolbar when needed. See the JToolBar Swing API for major details on how the toolbar object can be customized.

These are only the most used methods - the developer may create own subclasses of the CSSEditor and create public references to all methods specified in the javadoc documentation supplied with the product of the class sferyx.csseditor.CSSEditorRootPane .

Integrate the CSS Editor in the Sferyx JSyndrome HTML Editor Component Edition

In the latest versions of the Sferyx JSyndrome HTML Editor Component Edition there is the following method which allows to enable the CSS Editor integration if the CSS Editor's jar is available:

public void setCSSEditorIntegrationEnabled(boolean enabled)- enables the CSS Editor integration - when enabled an icon will appear at the end of the shortcuts toolbar of the HTML Editor which will permit to start the CSS Editor and edit the currently active document's style sheet. The CSS Editor will permit you to edit the available CSS selectors or create new ones. You can also load or save external style sheets and embed them directly into the HTML Editor's document with few simple clicks. Once the styles are created and inserted into the document, you can apply them to the various document elements through the different property dialogs for each element like paragraphs, tables, table cells, text etc.

When the CSSEditor integration within the HTML Editor Component is enabled, the following UI items will appear:

1) Toolbar button on the shortcuts toolbar:

2) "Edit Style Sheet" Popop Menu item on the HTML Editor's popup menu:

3) "Edit Style Sheet" Menu item on the "Formatting" menu on the main menu bar

Removing unnecessary UI items like menus and toolbar items

public void removeMenuItems(String menuItemNames)-This method is used for configuring the menu items - by default they are all shown. To remove them you can use this method along the names shown below:

PasteMenuItem - the paste menu item;
CutMenuItem - the cut menu item;
CopyMenuItem - the copy menu item;
OpenMenuItem - the open file menu item;
SaveMenuItem - the save file menu item;
ExitMenuItem - the exit menu item;
ExitSeparator - the exit menu separator;
NewWindowMenuItem - the new window menu item;
AboutMenuItem - the about menu item on the Help menu;

The usage format is like this: removeMenuItems("SaveMenuItem,OpenMenuItem");

public void removeMenu(String menuNames)-This method is used for configuring the menus - by default they are all shown. To remove them you can use this method along the names shown below:

EditMenu - edit menu;
FileMenu - file menu;
WindowMenu - window menu;
HelpMenu - help menu;

The usage format is like this: removeMenus("EditMenu,FileMenu");

public void removeToolbarItems(String toolbarItemNames)-This method is used for configuring the toolbar items - by default they are all shown. To remove them you can use this method along the names shown below:

CopyButton - the copy button;
CutButton - the cut button;
PasteButton - the paste button;
AddSelectorButton - the add new selector button;
NewButton - the new CSSEditor tab button;
OpenButton - the open file button;
SaveButton - the save file button;
DeleteSelectorButton - the delete selector button;

The usage format is like this: removeToolbarItems("PasteButton,OpenButton");

public void setSourceVisible(boolean visible)- Sets the visibility status of the currently active CSSEditor source editor - show/hide the currently active CSSEditor source editor

public void setToolbarVisible(boolean visible) - Sets the visibility status of the main toolbar - show/hide the main toolbar of the editor

public void setMainMenuVisible(boolean visible) -Sets the main menu visibility status - show/hide the main menu of the editor

Our Services and assistance

All Sferyx products are assured with continuous e-mail support. With the retail products is included in the price 30 days startup support. Additionally, you can purchase annual support subscription tickets from our web store.

Sferyx offers also a wide range of customization services for its products in order to satisfy any customer requirement. We can adapt our products to fit the customer needs and any kind of integration requirements. We execute also express developments, customization under request, development of new features on demand. You can request a quote at sales@sferyx.com or support@sferyx.com indicating your requirements and the terms of delivery.