Restricting GUI extension custom tab to a particular publication

Question

I have implemented an additional tab control to the edit window at the component presentation level for a page using the approach mentioned here : http://www.curlette.com/?p=753

However I need to restrict the custom tab to appear only for a particular publication and I also want the fields in the custom tab to be mandatory and hence I need a way of validating and informing the author if they are left empty.

My questions:

1. Is it possible to restrict the custom tab to appear on pages of a particular publication? If yes, how do we achieve it?
2. Where to validate for the mandatory fields under custom tab?

Answer 1

1\ Tab page initialize happen when user selects tab, but not when tab control initialized. You need to implement

Extension.Tab.prototype.setParentControl = function Extension$setParentControl()
{
    this.callBase("Tridion.Controls.DeckPage", "setParentControl", arguments);

    var item = $display.getItem();
    if (item)
    {
        this._updateTabState();
    }

    // if necessary
    // $evt.addEventHandler(item, "load", this.getDelegate(this._updateTabState));
    // $evt.addEventHandler(item, "loadfailed", this.getDelegate(this._updateTabState));
};

And _updateTabState

Extension.Tab.prototype._updateTabState = function Extension$_updateTabState(result)
{
    var p = this.properties;

    if (condition)
    {
        p.parentControl.showItem(this);
    }
    else
    {
        p.parentControl.hideItem(this);
    }

};

2\ When item is saving, it fires validate event before save, which you can handle. If your validation is ok, return true or nothing, otherwise – do return false

In initialize method: $evt.addEventHandler(item, "validate", this.getDelegate(this.onItemValidate));

And

Extension.Tab.prototype.onItemValidate = function Extension$onItemValidate(event)
{
    var c = this.properties.controls;
    if (c.ExtraField.value.length == 0)
    {
        $messages.registerError("This field is empty", null, null, true);
        return false;
    }
};

---

UPD:

As a good practice I`d strongly suggest to avoid using hardcoded uris.

When you have a condition by which you define to show/hide tab, you can export this condition into item properties via DataExtender.

And then Use by ItemType extending get an access to this property.

In this case, updateState Condition would look like

if (Type.implementsInterface(item , "Extension.ItemType.Publication")) && item.isNewTabShouldBeShown())

Answer 2

I don't think it is possible to only show a tab for a specific Publication, once you add a tab to a certain view/control, it will always be there. But you can choose to hide it (via CSS) in its initialize method when you are not in the Publication you want it in.

Following Roberts example code, you will want to adjust the initialize() method to something like this:

RC.HelloTab.prototype.initialize = function HelloTab$initialize()
{
  var item = $display.getItem();
  var pubId = item.getPublicationId();

  if (pubId == "tcm:0-4-1")
  {
    console.log('init');
    this.callBase("Tridion.Controls.DeckPage", "initialize");
    $evt.addEventHandler(item, "load", this.getDelegate(this.updateView));
  }
  else
  {
    // hide this tab through css in case it does still show up
  }
};

Answer 3

We are able to hid the tab by validating it against the publication and hiding it using setParentControl() in anguilla framework.

if (pubId != "your publication")
         this.getParentControl().hideItem(this);

Answer 4

You can try following in your command js.

Extensions.YourExnName.prototype.isAvailable = function YourExnName$isAvailable(target)
{

//check here for publication
    return true/false;;
};

Extensions.YourExnName.prototype.isEnabled = function YourExnName$isEnabled(target) {
//check here for publication
    return true/false;
};

2) Validation can be done using javaScript also in your onclick or other events, did you try?