Package ro.sync.ecss.extensions.api.editor

Interface InplaceEditorCSSConstants

  • All Known Subinterfaces:
    InplaceEditorArgumentKeys
    @API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface InplaceEditorCSSConstants
    Arguments of the oxy_editor function as well as built-in values for some of these arguments.
    Since:
    14.1

    • Field Detail

      • PROPERTY_ON_HOVER_PSEUDO_CLASS_NAME

        static final java.lang.String PROPERTY_ON_HOVER_PSEUDO_CLASS_NAME
        Common property for all form controls. If such a class is given, when the cursor is hovering a form control this class will be set on the element on which the form control is added. When the cursor leaves the form control this class is removed. As a result you can have CSS rules that change the rendering of the element when it is hovered. 
        
body:after {
    content:
        oxy_button(
            hoverPseudoclassName, "activeElement",
            actionID, 'action.id');
}
            
body {
    border:1px solid white;
}

body:activeElement {
    border:1px solid red;
}
        See Also:
        Constant Field Values

      • PROPERTY_HTML_EMBEDDED_CONTENT

        static final java.lang.String PROPERTY_HTML_EMBEDDED_CONTENT
        For an "oxy_html_content" function, this is the HTML content to render given embedded in the CSS.
        See Also:
        Constant Field Values

      • PROPERTY_ID

        static final java.lang.String PROPERTY_ID
        The ID of an HTML element from the file specified by the "href" argument of "oxy_html_content". It identifies the element to be rendered.
        See Also:
        Constant Field Values

      • PROPERTY_FILE_FILTER

        static final java.lang.String PROPERTY_FILE_FILTER
        A set of file extensions specifying the file types that should be shown in the dialog displayed by a URL chooser. The extensions are comma-separated.
        See Also:
        Constant Field Values

      • PROPERTY_TYPE

        static final java.lang.String PROPERTY_TYPE
        Indicates the editor that should be used to edit. One of TYPE_ constants or a class name. This is a shorthand to specify a built-in type of renderer and editor as opposed to using properties PROPERTY_RENDERER_CLASS_NAME, PROPERTY_SWING_EDITOR_CLASS_NAME and PROPERTY_SWT_EDITOR_CLASS_NAME.
        See Also:
        Constant Field Values

      • PROPERTY_EDIT

        @Deprecated
static final java.lang.String PROPERTY_EDIT
        Deprecated.
        Use InplaceEditorArgumentKeys.PROPERTY_EDIT_QUALIFIED instead. In case of an attribute it will offer a clark name instead of the QName used in the CSS.
        Indicates if we should edit an attribute value or the text value of the element. The following values are accepted:
        • To edit an attribute value the value of the property is "@attr_name".
        • To edit the text content the value should be equal with EDIT_TEXT_CONTENT
        • To let the editor do the editing itself, the value should be equal with EDIT_CUSTOM
        See Also:
        Constant Field Values

      • PROPERTY_VALUES

        static final java.lang.String PROPERTY_VALUES
        A set of values to be presented as choices. If not present these values will be taken from the schema. The processed value for this property is a list of CIValue.
        See Also:
        Constant Field Values

      • PROPERTY_CAN_REMOVE_VALUE

        static final java.lang.String PROPERTY_CAN_REMOVE_VALUE
        Property used for a non-editable combo box form control. If it is set to true, then the combo box will have an "<Empty>" value inside, which will clear/remove the last combo box value.
        See Also:
        Constant Field Values

      • PROPERTY_UNCHECKED_VALUES

        static final java.lang.String PROPERTY_UNCHECKED_VALUES
        Used only when PROPERTY_TYPE is set to TYPE_CHECKBOX. These are the values that are committed for a checkbox when it is unchecked. If missing, an unchecked button will commit no value. The processed value for this property is a list of CIValue.
        See Also:
        Constant Field Values

      • PROPERTY_LABELS

        static final java.lang.String PROPERTY_LABELS
        A set of labels to be associated with PROPERTY_VALUES. The processed value for this property is a java.util.List<String>
        See Also:
        Constant Field Values

      • PROPERTY_TOOLTIPS

        static final java.lang.String PROPERTY_TOOLTIPS
        A set of tooltips to be associated with PROPERTY_VALUES. The processed value for this property is a java.util.List<String>
        See Also:
        Constant Field Values

      • PROPERTY_ROWS

        static final java.lang.String PROPERTY_ROWS
        The number of rows that the editor should have. It's interpretation is dependent to the editor being used.
        See Also:
        Constant Field Values

      • PROPERTY_COLUMNS

        static final java.lang.String PROPERTY_COLUMNS
        The number of columns that the editor should have. It's interpretation is dependent to the editor being used.
        See Also:
        Constant Field Values

      • PROPERTY_SEPARATOR

        static final java.lang.String PROPERTY_SEPARATOR
        Used only when PROPERTY_TYPE is set to TYPE_CHECKBOX or TYPE_POPUP_SELECTION. This is the separator that will be used to compose the values from the check-boxes into one string that will be committed into the document. If no separator is specified, a space will be used.
        See Also:
        Constant Field Values

      • PROPERTY_RENDERER_SEPARATOR

        static final java.lang.String PROPERTY_RENDERER_SEPARATOR
        Used only when PROPERTY_TYPE is set to TYPE_POPUP_SELECTION. This is the separator that will be used to compose the values from the check-boxes into one string that will be rendered in the document. If no separator is specified, PROPERTY_SEPARATOR will be used to identify tokens.
        See Also:
        Constant Field Values

      • PROPERTY_SORT

        static final java.lang.String PROPERTY_SORT
        Used only when PROPERTY_TYPE is set to TYPE_POPUP_SELECTION and PROPERTY_SELECTION_MODE is set to SELECTION_MODE_MULTIPLE. This is the order in which the values in the element or attribute will appear. This sorting property will apply to both the values rendered in the editor and the ones presented in the pop-up editor. If no sort order is specified, the values will be rendered in the order in which they appear in the document.
        See Also:
        Constant Field Values

      • PROPERTY_RENDERER_SORT

        static final java.lang.String PROPERTY_RENDERER_SORT
        Used only when PROPERTY_TYPE is set to TYPE_POPUP_SELECTION. This is the order in which the values in the element or attribute will appear rendered in the editor. If no sort order is specified, the values will be rendered in the order in which they appear in the document.
        See Also:
        Constant Field Values

      • PROPERTY_EDITABLE

        static final java.lang.String PROPERTY_EDITABLE
        Only applies when the editor is a combo box and marks the combo as being editable or not. possible values are Boolean.TRUE and Boolean.FALSE.
        See Also:
        Constant Field Values

      • PROPERTY_ACTION_ID

        static final java.lang.String PROPERTY_ACTION_ID
        Only applies to the TYPE_BUTTON and represents the ID of the action that must be invoked when the button is pressed. It's processed value is an IAuthorExtensionAction. If an action with the given ID wasn't found the value remains the given string ID.
        See Also:
        Constant Field Values

      • PROPERTY_TRANSPARENT

        static final java.lang.String PROPERTY_TRANSPARENT
        Only applies to the TYPE_BUTTON and ensures whether the button will have a more flat appearance (transparent). The accepted values are true and false. The default value is false which will determine a classic looking button. When true, the SWING button will have no borders while the SWT one will be a tool item. The processed values will be either Boolean.TRUE or Boolean.FALSE.
        See Also:
        Constant Field Values

      • PROPERTY_ACTION_IDS

        static final java.lang.String PROPERTY_ACTION_IDS
        Only applies to the TYPE_BUTTON_GROUP and contains a list of comma separated IDs of the actions that are presented to the user in a pop-up menu. It's processed value is a list of IAuthorExtensionAction. If one of the actions IDs wasn't found the value remains the given string ID.
        See Also:
        Constant Field Values

      • PROPERTY_ICON

        static final java.lang.String PROPERTY_ICON
        Only applies to the TYPE_BUTTON_GROUP and specifies the path to an Icon to be displayed on the button. The processed value is an Icon to be displayed on the button or null if no icon is specified or the specified one cannot be loaded.
        See Also:
        Constant Field Values

      • PROPERTY_SHOW_TEXT

        static final java.lang.String PROPERTY_SHOW_TEXT
        Only applies to the TYPE_BUTTON and specifies if the text should be displayed on the button. If missing, the button displays only the icon if it is available, or the text if the icon is not available. This is a boolean property.
        See Also:
        Constant Field Values

      • PROPERTY_SHOW_ICON

        static final java.lang.String PROPERTY_SHOW_ICON
        Only applies to the TYPE_BUTTON and specifies if the icon should be displayed on the button. If missing, the button displays only the icon if it is available, or the text if the icon is not available. This is a boolean property.
        See Also:
        Constant Field Values

      • PROPERTY_ENABLE_IN_READ_ONLY_CONTEXT

        static final java.lang.String PROPERTY_ENABLE_IN_READ_ONLY_CONTEXT
        Controls whether the button is enabled/disabled in read-only context. Default value is FALSE.
        See Also:
        Constant Field Values

      • PROPERTY_LABEL

        static final java.lang.String PROPERTY_LABEL
        Only applies to the TYPE_BUTTON_GROUP and specifies the label of the button that triggers the pop-up menu.
        See Also:
        Constant Field Values

      • PROPERTY_TOOLTIP

        static final java.lang.String PROPERTY_TOOLTIP
        Only applies to the TYPE_BUTTON_GROUP and TYPE_TEXT and specifies the tooltip for the button that triggers the pop-up menu with the actions in the group.
        See Also:
        Constant Field Values

      • PROPERTY_ACTION_DISPLAY_STYLE

        static final java.lang.String PROPERTY_ACTION_DISPLAY_STYLE
        Only applies to the TYPE_BUTTON_GROUP and specifies what to display for an action: icon, text or both.
        See Also:
        Constant Field Values

      • PROPERTY_RENDERER_CLASS_NAME

        static final java.lang.String PROPERTY_RENDERER_CLASS_NAME
        Class name of the renderer. This must be a SWING implementation for both the Oxygen stand alone or Eclipse plugin version. This class will be look for in the class path of the associated document type or in the PROPERTY_CLASSPATH.
        See Also:
        Constant Field Values

      • PROPERTY_SWING_EDITOR_CLASS_NAME

        static final java.lang.String PROPERTY_SWING_EDITOR_CLASS_NAME
        Class name of the editor. The SWING implementation is used for the Oxygen stand alone. This class will be look for in the class path of the associated document type or in the PROPERTY_CLASSPATH.
        See Also:
        Constant Field Values

      • PROPERTY_SWT_EDITOR_CLASS_NAME

        static final java.lang.String PROPERTY_SWT_EDITOR_CLASS_NAME
        Class name of the editor. The SWT implementation is used for the Eclipse plugin version. This class will be look for in the class path of the associated document type or in the PROPERTY_CLASSPATH.
        See Also:
        Constant Field Values

      • PROPERTY_WEBAPP_RENDERER_CLASS_NAME

        static final java.lang.String PROPERTY_WEBAPP_RENDERER_CLASS_NAME
        Class name of the server-side renderer used in the Author Webapp. This class will be looked for in the class path of the associated document type or in the PROPERTY_CLASSPATH.
        See Also:
        Constant Field Values

      • PROPERTY_CLASSPATH

        static final java.lang.String PROPERTY_CLASSPATH
        If the form control is a custom implementation this property can be used to specify the class path where the custom implementation will loaded from. A comma separated enumeration of URLs.
        See Also:
        Constant Field Values

      • PROPERTY_FONT_INHERIT

        static final java.lang.String PROPERTY_FONT_INHERIT
        Property used to specify that the font is inherited from the parent element. Its possible values are true or false.
        See Also:
        Constant Field Values

      • PROPERTY_COLOR

        static final java.lang.String PROPERTY_COLOR
        Property used to specify the foreground color. Its possible values are a color or 'inherit' if the color should be inherited from the element.
        See Also:
        Constant Field Values

      • PROPERTY_CONTENT_TYPE

        static final java.lang.String PROPERTY_CONTENT_TYPE
        Property used to specify the content type of the edited string. The values belongs to the ContentTypes
        See Also:
        Constant Field Values

      • PROPERTY_VISIBLE

        static final java.lang.String PROPERTY_VISIBLE
        Property used to specify if an in-place editor is visible. Its possible values are true or false.
        See Also:
        Constant Field Values

      • PROPERTY_VALIDATE_INPUT

        static final java.lang.String PROPERTY_VALIDATE_INPUT
        Controls the validation of the input.
        See Also:
        Constant Field Values

      • PROPERTY_INDENT_ON_TAB

        static final java.lang.String PROPERTY_INDENT_ON_TAB
        Controls the TAB behavior in the text area form control. If this property is true, TAB is used for indentation instead of navigation. By default, it is set to true.
        See Also:
        Constant Field Values

      • ACTION_CONTEXT_ELEMENT

        static final java.lang.String ACTION_CONTEXT_ELEMENT
        Possible value for PROPERTY_ACTION_CONTEXT. The action will be executed in the context of the element associated with the form control.

        We want the form control below to delete the li element even if the caret is located in a descendant of li. 

         li:before {
   content:oxy_button(actionID, 'delete.element', actionContext, 'element')
 }
        See Also:
        Constant Field Values

      • ACTION_CONTEXT_CARET

        static final java.lang.String ACTION_CONTEXT_CARET
        Possible value for PROPERTY_ACTION_CONTEXT. The action will be executed in the current selection context. The selection/caret must be inside the element associated with the form control. Otherwise the action will be executed in ACTION_CONTEXT_ELEMENT context.

        The form control is added on a 'para' element. Whenever the user makes a selection inside 'para' and clicks the button we want to wrap the existing selection in a 'b' element. 

         para:before {
   content:oxy_button(actionID, 'bold.wrap', actionContext, 'caret')
 }
        See Also:
        Constant Field Values

      • TYPE_BUTTON

        static final java.lang.String TYPE_BUTTON
        Possible value for PROPERTY_TYPE. Indicates that a combo box should be used to render and edit.
        See Also:
        Constant Field Values

      • TYPE_COMBOBOX

        static final java.lang.String TYPE_COMBOBOX
        Possible value for PROPERTY_TYPE. Indicates that a combo box should be used to render and edit.
        See Also:
        Constant Field Values

      • TYPE_TEXT

        static final java.lang.String TYPE_TEXT
        Possible value for PROPERTY_TYPE. Indicates that a text field with content completion support should be used to render and edit.
        See Also:
        Constant Field Values

      • TYPE_TEXT_AREA

        static final java.lang.String TYPE_TEXT_AREA
        Possible value for PROPERTY_TYPE. Indicates that a text area with syntax highlight support should be used to render and edit.
        See Also:
        Constant Field Values

      • TYPE_HTML_CONTENT

        static final java.lang.String TYPE_HTML_CONTENT
        Possible value for PROPERTY_TYPE. Indicates that a pane with HTML interpreting support should be used to render.
        See Also:
        Constant Field Values

      • TYPE_CHECKBOX

        static final java.lang.String TYPE_CHECKBOX
        Possible value for PROPERTY_TYPE. Indicates that a check box panel should be used to render and edit.
        See Also:
        Constant Field Values

      • TYPE_POPUP_SELECTION

        static final java.lang.String TYPE_POPUP_SELECTION
        The renderer presents a simple or compose value and the editor shows a pop-up like panel in which we can choose the values.
        See Also:
        Constant Field Values

      • TYPE_URL_CHOOSER

        static final java.lang.String TYPE_URL_CHOOSER
        Possible value for PROPERTY_TYPE. Indicates that a URL chooser should be used to render and edit. The new type of URL chooser that uses an InputUrlPanel.
        See Also:
        Constant Field Values

      • TYPE_BUTTON_GROUP

        static final java.lang.String TYPE_BUTTON_GROUP
        Possible value for PROPERTY_TYPE. Indicates that a button with a pop-up menu that contains a list of actions should be used to render and edit.
        See Also:
        Constant Field Values

      • EDIT_TEXT_CONTENT

        static final java.lang.String EDIT_TEXT_CONTENT
        Value of the PROPERTY_EDIT that indicates that the text content of the element must be edited.
        See Also:
        Constant Field Values

      • EDIT_XML_CONTENT

        static final java.lang.String EDIT_XML_CONTENT
        Handled only for a text area editor TYPE_TEXT_AREA. This parameter is useful when an element has mixed or element-only content and you want to edit its content inside a text area form control. For example:

        XML:

        <codeblock outputclass="language-xml">START_TEXT<ph>phase</ph><apiname><text>API</text></apiname></codeblock>

        CSS

        codeblock:before{
content:
    oxy_textArea(
      edit, content,
      contentType, 'text/xml');
}
        The text area form control will edit this fragment:

        START_TEXT<ph>phase</ph><apiname><text>API</text></apiname>

        See Also:
        Constant Field Values

      • FALSE

        static final java.lang.String FALSE
        Possible value for PROPERTY_EDITABLE that marks the combo as NOT being editable.
        See Also:
        Constant Field Values

      • TRUE

        static final java.lang.String TRUE
        Possible value for PROPERTY_EDITABLE that marks the combo as being editable.
        See Also:
        Constant Field Values

      • SELECTION_MODE_SINGLE

        static final java.lang.String SELECTION_MODE_SINGLE
        Possible value for "selectionMode". Only a single value will be selected.
        See Also:
        Constant Field Values

      • SELECTION_MODE_MULTIPLE

        static final java.lang.String SELECTION_MODE_MULTIPLE
        Possible value for "selectionMode". It allows multiple values to be selected.
        See Also:
        Constant Field Values

      • TYPE_DATE_PICKER

        static final java.lang.String TYPE_DATE_PICKER
        An editor that can be used to edit dates. It handles schema types xs:date and xs:datetime or any type with a specified Java format from CSS.
        See Also:
        Constant Field Values

      • TYPE_OLD_URL_CHOOSER

        static final java.lang.String TYPE_OLD_URL_CHOOSER
        The old url chooser. Left here as a workaround if someone got really attached to it.
        See Also:
        Constant Field Values

      • PROPERTY_FORMAT

        static final java.lang.String PROPERTY_FORMAT
        It applies only on date picker form control. It specifies the date-time format of the edited value.
        See Also:
        Constant Field Values

      • COMMA

        static final java.lang.String COMMA
        The variable used to add a comma in property values. The real comma is used as a delimiter for multiple values thus this special variable is needed.
        See Also:
        Constant Field Values

      • INHERIT

        static final java.lang.String INHERIT
        Value constant used for the color property.
        See Also:
        Constant Field Values

      • PROPERTY_HAS_MULTIPLE_VALUES

        static final java.lang.String PROPERTY_HAS_MULTIPLE_VALUES
        Property that can be set on a text field form control. If true, then the form control can have multiple values, separated by spaces. If false, it can have a single value. The default is true.
        See Also:
        Constant Field Values

      • TYPE_VIDEO_PLAYER

        static final java.lang.String TYPE_VIDEO_PLAYER
        Possible value for PROPERTY_TYPE. Indicates a video player.
        See Also:
        Constant Field Values

      • TYPE_AUDIO_PLAYER

        static final java.lang.String TYPE_AUDIO_PLAYER
        Possible value for PROPERTY_TYPE. Indicates an audio player.
        See Also:
        Constant Field Values

      • TYPE_BROWSER

        static final java.lang.String TYPE_BROWSER
        Possible value for PROPERTY_TYPE. Indicates a JavaFX-based browser.
        See Also:
        Constant Field Values

      • PROPERTY_SA_HEAVY_FORM_CONTROL_CLASS_NAME

        static final java.lang.String PROPERTY_SA_HEAVY_FORM_CONTROL_CLASS_NAME
        Heavy weight form controls extension point. These form controls differ from the classic form control by the fact that they are placed in the component hierarchy from the very beginning. Class name of a heavy weight form control. This implementation is used in the Desktop version of Oxygen.

        Note If Oxygen is running as a Eclipse plugin then you'll have to use PROPERTY_ECLIPSE_HEAVY_FORM_CONTROL_CLASS_NAME

        Note If Oxygen is running as a Standalone or Desktop version then you'll have to use PROPERTY_WEBAPP_RENDERER_CLASS_NAME

        This class will be look for in the class path of the associated document type or in the PROPERTY_CLASSPATH.
        See Also:
        Constant Field Values

      • PROPERTY_ECLIPSE_HEAVY_FORM_CONTROL_CLASS_NAME

        static final java.lang.String PROPERTY_ECLIPSE_HEAVY_FORM_CONTROL_CLASS_NAME
        Heavy weight form controls extension point. These form controls differ from the classic form control by the fact that they are placed in the component hierarchy from the very beginning. Class name of a heavy weight form control. This implementation is used when Oxygen is running inside an Eclipse environment.

        Note If Oxygen is running as a Standalone or Desktop version then you'll have to use PROPERTY_SA_HEAVY_FORM_CONTROL_CLASS_NAME

        Note If Oxygen is running as a Standalone or Desktop version then you'll have to use PROPERTY_WEBAPP_RENDERER_CLASS_NAME

        This class will be look for in the class path of the associated document type or in the PROPERTY_CLASSPATH.
        See Also:
        Constant Field Values

      • PROPERTY_ON_CHANGE

        static final java.lang.String PROPERTY_ON_CHANGE
        Combo box property. Can be used to invoke an action every time combo changes its value.
        See Also:
        Constant Field Values