Support and Documentation

Within the same Placement (top, bottom, right, dedicated tab), Brightspot by default positions custom widgets in alphabetical order based on the class's fully qualified name. For example, suppose you defined three custom widgets, widgets.AdamsCustomWidget, widgets.JacksCustomWidget, and specials.widgets.ZoesCustomWidget, and all of them appear under the Content Edit Form. By default, Brightspot positions them in alphabetical order as in the following illustration.

You can override the alphabetical sorting for custom widgets by implementing the method ContentEditWidget#getPosition and returning a double value. Values with smaller numbers appear closer to the top, and the default value is zero. Positions with the same value are sorted alphabetically by fully qualified class name.

import com.psddev.cms.tool.ContentEditWidget;
import com.psddev.cms.tool.ContentEditWidgetPlacement;
import com.psddev.cms.tool.ToolPageContext;

public class JillsCustomWidget extends ContentEditWidget {

    @Override
    public ContentEditWidgetPlacement getPlacement(ToolPageContext toolPageContext, Object o) { 1
        return ContentEditWidgetPlacement.BOTTOM;
    }

    @Override
    public double getPosition(ToolPageContext page, Object content, ContentEditWidgetPlacement placement) { 2
        return 8.0;
    }

    @Override
    public String getHeading(ToolPageContext page, Object content) {
        return "Jill's Custom Widget";
    }

    @Override
    public void display(ToolPageContext page, Object content, ContentEditWidgetPlacement placement) throws IOException {
        page.writeStart("p");
        page.writeHtml("Here is Jill's custom widget.");
        page.writeEnd();
    }
}

Suppose you assign Zoe's, Adam's, Jack's, and Jill's widgets return values for getPosition as in the following table.

Because all the widgets have the same placement, Brightspot lays them out as in the following illustration.

Both Zoe's and Adam's widgets have the same return value for getPosition, so Brightspot breaks the tie by sorting by fully qualified class name.

If you use a custom widget that is imported from another package, that widget may have a result from getPosition that conflicts with your implementation. Referring to the table Example values for positioning widgets, Zoe's custom widget has a position of 10, but you may want to place her widget first, in front of all the other custom widgets.

You can use Substitutions to incorporate an imported widget into your project and then override the original value for getPosition.

import com.psddev.cms.tool.ContentEditWidgetPlacement;
import com.psddev.cms.tool.ToolPageContext;
import com.psddev.dari.db.Substitution;
import special.widgets.ZoesCustomWidget; 1

public class ZoesPortedCustomWidget extends ZoesCustomWidget implements Substitution { 2

    @Override
    public double getPosition(ToolPageContext page, Object content, ContentEditWidgetPlacement placement) { 3
        return 6.0;
    }

}

At run time, the ported custom widget appears first among all other custom widgets under the content edit form.