·¬ÇÑÉçÇø

import com.psddev.cms.tool.*;

public class CurrentTimesWidget extends ContentEditWidget { 

    @Override
    public void display(ToolPageContext page, Object content, ContentEditWidgetPlacement placement) throws IOException { 
        Map<String, String> timeZoneIdentifiers = new HashMap<>(); 
        timeZoneIdentifiers.put("New York", "America/New_York");
        timeZoneIdentifiers.put("Los Angeles", "America/Los_Angeles");
        timeZoneIdentifiers.put("Mexico City", "America/Mexico_City");

        page.writeStart("table");

            page.writeStart("tr"); 
                page.writeStart("th");
                    page.writeHtml("City");
                page.writeEnd(); /* th */
                page.writeStart("th");
                    page.writeHtml("Time");
                page.writeEnd(); /* th */
            page.writeEnd(); /* tr */

            for (String myTimeZone : timeZoneIdentifiers.keySet()) { 
                page.writeStart("tr");
                    page.writeStart("td");
                        page.writeHtml(myTimeZone);
                    page.writeEnd(); /* td */
                    page.writeStart("td");
                        String localTime = displayTime(timeZoneIdentifiers.get(myTimeZone));
                        page.writeHtml(localTime);
                    page.writeEnd(); /* td */
                page.writeEnd(); /* tr */
            }
        page.writeEnd(); /* table */
    }

    public ContentEditWidgetPlacement getPlacement(ToolPageContext page, Object content) { 
        return ContentEditWidgetPlacement.BOTTOM;
    }

    public String getHeading(ToolPageContext page, Object content) { 
        return "Current Times";
    }

    private String displayTime(String timeZoneIdentifier) {
        /* 
            Returns local time in hh:mm format based on
            passed time zone identifier.
        */
    }
}

• Declares the class CurrentTimesWidget. Objects instantiated from this class appear as Current Times Widget in the content edit page.
  
• Instantiates a HashMap of time zones.
• Writes a table header in the widget’s body.
• Loops through each time-zone record. For each record, call the method displayTime to retrieve and then print the time zone’s current time.
• Positions the widget under the content edit form. For details about positioning a widget on the content edit form, see Position.
• Displays the widget’s heading.

public class Reporter extends Content { 

    private String firstName;
    private String lastName;

    /* Getters and setters */

    public String getFullName() { 
        return getFirstName() + " " + getLastName();
    }
}

• Declares the class Reporter that extends from Content. In a more robust implementation, you might create the class Reporter that extends , create the class ReporterRole that extends , and then assign instances of Reporter to ReporterRole.
  
• Returns a reporter’s full name as a concatenation of the reporter’s first and last name.

public class Article extends Content {

    @ToolUi.Hidden
    private Reporter reporterCredit;

    public Reporter getReporterCredit() {
        return reporterCredit;
    }
}

import com.psddev.cms.tool.ContentEditWidgetPlacement;
import com.psddev.cms.tool.ToolPageContext;
import com.psddev.cms.tool.UpdatingContentEditWidget;
import com.psddev.dari.db.Query;
import content.article.*;

public class ReporterCreditWidget extends UpdatingContentEditWidget { 

    @Override
    public void displayOrUpdate(ToolPageContext page, Object content, ContentEditWidgetPlacement placement) throws IOException {

        Article myArticle = (Article) content; 

        if (placement == null) { 
            UUID reporterID = page.param(UUID.class, "reporter.select"); 
            Reporter creditedReporter = Query.from(Reporter.class).where("id = ?", reporterID).first(); 
            myArticle.setReporterCredit(creditedReporter); 
            return;
        }

        List<Reporter> reporters = Query.from(Reporter.class).selectAll(); 
        Reporter currentReporter = myArticle.getReporterCredit(); 

        page.writeStart("select", "name", "reporter.select"); 
            page.writeStart("option", "value", "").writeEnd(); /* Initial blank option */
            for (Reporter reporter : reporters) { 
                page.writeStart("option", "selected", reporter.equals(currentReporter) ? "selected" : null, "value", reporter.getId()); 
                    page.writeHtml(reporter.getFullName()); 
                page.writeEnd(); /* option */ 
            }
        page.writeEnd(); /* select */
    }

    @Override
    public ContentEditWidgetPlacement getPlacement(ToolPageContext page, Object content) { 
        return ContentEditWidgetPlacement.RIGHT;
    }

    @Override
    public String getHeading(ToolPageContext page, Object content) { 
        return "Reporter Credit";
    }

    @Override
    public boolean shouldDisplay(ToolPageContext page, Object content) { 
        return content instanceof Article;
    }
}

• Declares the class ReporterCreditWidget as a subclass of an updating content widget.
  
• Callback for displaying or updating a content edit widget.
• Casts the incoming asset as an Article.
• Traps the widget’s update event.
• Retrieves the selected reporter’s UUID.
• Retrieves the Reporter record matching the selected reporter’s UUID.
• Assigns the retrieved reporter record to the article.
• Retrieves all of the reporters.
• Retrieves the current article’s reporter credit.
• Renders the widget's bgody with an HTML <select> field. The field’s options are a default blank entry and the list of retrieved reporters.
• Positions the widget in the right rail.
• Displays the widget’s heading Reporter Credit.
• Displays the widget if the current content type is an article.

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) { 
        return ContentEditWidgetPlacement.BOTTOM;
    }

    @Override
    public double getPosition(ToolPageContext page, Object content, ContentEditWidgetPlacement placement) { 
        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();
    }
}

• Places Jill’s widget under the content edit form.
• Assigns Jill’s widget a relative position of 8.0

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

public class ZoesPortedCustomWidget extends ZoesCustomWidget implements Substitution { 

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

}

• Imports the custom widget ZoesCustomWidget from another package.
• Declares a ported custom widget ZoesPortedCustomWidget by extending the imported custom widget and implementing Substitution.
• Overrides the imported widget’s position, now assigning it 6 (compared to the original 10 as listed in the table "Example values for positioning widgets"). This position value is the lowest of all other custom widgets.
  

public ContentEditWidgetPlacement getPlacement(ToolPageContext page, Object content) {
    /* Return one of the placement constants. */
}

import com.psddev.cms.db.Content;
import com.psddev.cms.db.ToolUi;
import com.psddev.cms.tool.ContentEditWidgetDisplay;
import com.psddev.cms.tool.content.UrlsWidget;
import com.psddev.dari.db.Recordable;

public class Article extends Content implements ContentEditWidgetDisplay {

    @Recordable.Required
    private String headline;

    @ToolUi.RichText
    private String body;

    @Override
    public boolean shouldDisplayContentEditWidget(String widgetName) { 
        if (widgetName.equals(UrlsWidget.class.getName())) {
            return false;
        } else {
            return true;
        }
    }
}

• Implements the method shouldDisplayContentEditWidget. Brightspot calls this method for each widget eligible to appear in the content edit page. If the widget’s name is the same as the URLs widget’s name, the method returns false and the widget does not appear. See the following illustration.
  

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

public class CurrentTimesWidget extends ContentEditWidget {

    @Override
    public void display(ToolPageContext page, Object content, ContentEditWidgetPlacement placement) throws IOException { 

        page.writeStart("p");
            page.writeHtml("My widget for personal notes.");
        page.writeEnd(); /* p */
    }

    public ContentEditWidgetPlacement getPlacement(ToolPageContext page, Object content) {
        return ContentEditWidgetPlacement.BOTTOM;
    }

    public String getHeading(ToolPageContext page, Object content) {
        return "My Custom Widget";
    }

    @Override
    public boolean shouldDisplay(ToolPageContext page, Object content) { 
        return false;
    }
}

• Defines a custom widget that appears under the content edit form.
• Hides the custom widget from the content edit page. See the following examples.